org.osid.course.program.batch

Interface ProgramOfferingBatchForm

All Superinterfaces:

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

public interface ProgramOfferingBatchForm
extends ProgramOfferingForm

This is the form for creating and updating program offerings in bulk. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ProgramOfferingBatchAdminSession. 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	getProgramId() Gets the program Id of the program offering if this is a create transaction.
Id	getProgramOfferingId() Gets the Id of the program offering to be updated if this is an update transaction.
Id	getTermId() Gets the term Id of the porgram offering if this is a create transaction.

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

clearCompletionRequirements, clearCompletionRequirementsInfo, clearCredentials, clearMaximumSeats, clearMinimumSeats, clearNumber, clearRequiresRegistration, clearSponsors, clearTitle, clearURL, getCompletionRequirementsInfoMetadata, getCompletionRequirementsMetadata, getCredentialsMetadata, getMaximumSeatsMetadata, getMinimumSeatsMetadata, getNumberMetadata, getProgramOfferingFormRecord, getRequiresRegistrationMetadata, getSponsorsMetadata, getTitleMetadata, getURLMetadata, setCompletionRequirements, setCompletionRequirementsInfo, setCredentials, setMaximumSeats, setMinimumSeats, setNumber, setRequiresRegistration, setSponsors, setTitle, setURL

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

getProgramId

Id getProgramId()

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

Returns:

the program Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getTermId

Id getTermId()

Gets the term Id of the porgram offering if this is a create transaction.

Returns:

the term Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getProgramOfferingId

Id getProgramOfferingId()

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

Returns:

the program offering Id

Throws:

IllegalStateException - isForUpdate() is false

Compliance:

mandatory - This method must be implemented.