org.osid.course.program.batch

Interface EnrollmentBatchForm

All Superinterfaces:

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

public interface EnrollmentBatchForm
extends EnrollmentForm

This is the form for creating and updating enrollments in bulk. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the EnrollmentBatchAdminSession. 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	getEnrollmentId() Gets the Id of the enrollment to be updated if this is an update transaction.
Id	getProgramOfferingId() Gets the program offering Id of the enrollment if this is a create transaction.
Id	getStudentId() Gets the student resource Id of the enrollment if this is a create transaction.

Methods inherited from interface org.osid.course.program.EnrollmentForm

getEnrollmentFormRecord

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

getProgramOfferingId

Id getProgramOfferingId()

Gets the program offering Id of the enrollment if this is a create transaction.

Returns:

the program offering Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getStudentId

Id getStudentId()

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

Returns:

the resource Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getEnrollmentId

Id getEnrollmentId()

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

Returns:

the enrollment Id

Throws:

IllegalStateException - isForUpdate() is false

Compliance:

mandatory - This method must be implemented.