org.osid.course.registration.batch

Interface RegistrationBatchForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidRelationshipForm, OsidTemporalForm, RegistrationForm, Suppliable

public interface RegistrationBatchForm
extends RegistrationForm

This is the form for creating and updating registrations in bulk. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the RegistrationBatchAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

Method Summary

Methods

Modifier and Type	Method and Description
Id	getActivityBundleId() Gets the ActivityBundle Id of the registration if this is a create transaction.
Id	getRegistrationId() Gets the Id of the registration to be updated if this is an update transaction.
Id	getStudentId() Gets the student Id of the registration if this is a create transaction.

Methods inherited from interface org.osid.course.registration.RegistrationForm

clearCredits, clearGradingOption, getCreditsMetadata, getGradingOptionMetadata, getRegistrationFormRecord, setCredits, setGradingOptions

Methods inherited from interface org.osid.OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Method Detail

getActivityBundleId

Id getActivityBundleId()

Gets the ActivityBundle Id of the registration if this is a create transaction.

Returns:

the activity bundle Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getStudentId

Id getStudentId()

Gets the student Id of the registration if this is a create transaction.

Returns:

the resource Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getRegistrationId

Id getRegistrationId()

Gets the Id of the registration to be updated if this is an update transaction.

Returns:

the registration Id

Throws:

IllegalStateException - isForUpdate() is false

Compliance:

mandatory - This method must be implemented.