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.

Like all OsidForms, ProgramOfferingBatchForm is stateful and must not be accessed by multiple processing threads.

Method Summary

Modifier and Type	Method	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 Extensible

getRecordTypes, hasRecordType

Methods inherited from interface Identifiable

getId, isCurrent

Methods inherited from interface OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface OsidForm

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

Methods inherited from interface OsidObjectForm

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

Methods inherited from interface OsidRelationshipForm

clearEndReason, getEndReasonMetadata, setEndReason

Methods inherited from interface OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Methods inherited from interface ProgramOfferingForm

clearCompletionRequirements, clearCompletionRequirementsInfo, clearCredentials, clearLearningObjectives, clearMaximumSeats, clearMinimumSeats, clearNumber, clearParentProgramOffering, clearRequiresRegistration, clearRestrictedAudiences, clearSponsors, clearTitle, clearURL, getCompletionRequirementsInfoMetadata, getCompletionRequirementsMetadata, getCredentialsMetadata, getLearningObjectivesMetadata, getMaximumSeatsMetadata, getMinimumSeatsMetadata, getNumberMetadata, getParentProgramOfferingMetadata, getProgramOfferingFormRecord, getRequiresRegistrationMetadata, getRestrictedAudiencesMetadata, getSponsorsMetadata, getTitleMetadata, getURLMetadata, setCompletionRequirements, setCompletionRequirementsInfo, setCredentials, setLearningObjectives, setMaximumSeats, setMinimumSeats, setNumber, setParentProgramOffering, setRequiresRegistration, setRestrictedAudiences, setSponsors, setTitle, setURL

Method Details

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.