org.osid.course.registration.batch

Interface ActivityRegistrationBatchForm

All Superinterfaces:

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

public interface ActivityRegistrationBatchForm
extends ActivityRegistrationForm

This is the form for creating and updating activity registrations in bulk. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ActivityRegistrationBatchAdminSession. 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	getActivityId() Gets the Activity Id of the activity registration if this is a create transaction.
Id	getActivityRegistrationId() Gets the Id of the activity registration to be updated if this is an update transaction.
Id	getRegistrationId() Gets the Registration Id of the activity registration if this is a create transaction.
Id	getStudentId() Gets the student resource Id of the activity registration if this is a create transaction.

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

getActivityRegistrationFormRecord

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

getRegistrationId

Id getRegistrationId()

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

Returns:

the registration Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getActivityId

Id getActivityId()

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

Returns:

the activity Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getStudentId

Id getStudentId()

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

Returns:

the resource Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getActivityRegistrationId

Id getActivityRegistrationId()

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

Returns:

the activity registration Id

Throws:

IllegalStateException - isForUpdate() is false

Compliance:

mandatory - This method must be implemented.