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

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

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidExtensibleForm

getRequiredRecordTypes

Modifier and Type	Method	Description
TypeList	getRequiredRecordTypes()	Gets the minimum required record types for successful submission of this OsidForm .

Methods inherited from interface OsidForm

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

Modifier and Type	Method	Description
Locale	getDefaultLocale()	Gets a default locale for the form.
Metadata[]	getInvalidMetadata()	Gets a list of metadata for the elements in this form which are not valid.
Metadata	getJournalCommentMetadata()	Gets the metadata for the comment corresponding to this form submission.
LocaleList	getLocales()	Gets the locales available for this form.
DisplayText[]	getValidationMessages()	Gets text messages corresponding to additional instructions to pass form validation.
boolean	isForUpdate()	Tests if this form is for an update operation.
boolean	isValid()	Tests if this form is in a valid state for submission.
void	setJournalComment(String comment)	Sets a comment.
void	setLocale(Type languageType, Type scriptType)	Specifies a language and script type for the form.

Methods inherited from interface OsidObjectForm

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

Modifier and Type	Method	Description
void	clearDescription()	Clears the description.
void	clearDisplayName()	Clears the display name.
void	clearGenusType()	Clears the genus type.
Metadata	getDescriptionMetadata()	Gets the metadata for a description.
Metadata	getDisplayNameMetadata()	Gets the metadata for a display name.
Metadata	getGenusTypeMetadata()	Gets the metadata for a genus type.
void	setDescription(String description)	Sets a description.
void	setDisplayName(String displayName)	Sets a display name.
void	setGenusType(Type genusType)	Sets a genus.

Methods inherited from interface OsidRelationshipForm

clearEndReason, getEndReasonMetadata, setEndReason

Modifier and Type	Method	Description
void	clearEndReason()	Removes the end reason.
Metadata	getEndReasonMetadata()	Gets the metadata for the end reason.
void	setEndReason(Id stateId)	Sets the end reason.

Methods inherited from interface OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Modifier and Type	Method	Description
void	clearEndDate()	Clears the end date.
void	clearStartDate()	Clears the start date.
Metadata	getEndDateMetadata()	Gets the metadata for an end date.
Metadata	getStartDateMetadata()	Gets the metadata for a start date.
void	setEndDate(DateTime date)	Sets the end date.
void	setStartDate(DateTime date)	Sets the start date.

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

Modifier and Type	Method	Description
void	clearCompletionRequirements()	Removes the completion requirements requisites.
void	clearCompletionRequirementsInfo()	Removes the completion requirements information.
void	clearCredentials()	Removes the credentials.
void	clearLearningObjectives()	Removes the learning objectives.
void	clearMaximumSeats()	Removes the maximum seats.
void	clearMinimumSeats()	Removes the minimum seats.
void	clearNumber()	Removes the program number.
void	clearParentProgramOffering()	Removes the parent program offering.
void	clearRequiresRegistration()	Removes the requires registration flag.
void	clearRestrictedAudiences()	Removes the restricted audiences.
void	clearSponsors()	Removes the sponsors.
void	clearTitle()	Removes the title.
void	clearURL()	Removes the url.
Metadata	getCompletionRequirementsInfoMetadata()	Gets the metadata for a completion requirements informational string.
Metadata	getCompletionRequirementsMetadata()	Gets the metadata for a completion requirements requisites.
Metadata	getCredentialsMetadata()	Gets the metadata for a set of credentials.
Metadata	getLearningObjectivesMetadata()	Gets the metadata for the learning objectives.
Metadata	getMaximumSeatsMetadata()	Gets the metadata for the maximum seats.
Metadata	getMinimumSeatsMetadata()	Gets the metadata for the minimum seats.
Metadata	getNumberMetadata()	Gets the metadata for a program offering number.
Metadata	getParentProgramOfferingMetadata()	Gets the metadata for the parent program offering.
ProgramOfferingFormRecord	getProgramOfferingFormRecord(Type programOfferingRecordType)	Gets the ProgramOfferingFormRecord corresponding to the given program offering record Type .
Metadata	getRequiresRegistrationMetadata()	Gets the metadata for requires registration flag.
Metadata	getRestrictedAudiencesMetadata()	Gets the metadata for a set of restricted audiences.
Metadata	getSponsorsMetadata()	Gets the metadata for the sponsors.
Metadata	getTitleMetadata()	Gets the metadata for a program title.
Metadata	getURLMetadata()	Gets the metadata for a program url.
void	setCompletionRequirements(Id[] requisiteIds)	Sets the completion requirements requisites.
void	setCompletionRequirementsInfo(String requirements)	Sets the completion requirements information.
void	setCredentials(Id[] credentialIds)	Sets the credentials.
void	setLearningObjectives(Id[] objectiveIds)	Sets the learning objectives.
void	setMaximumSeats(long seats)	Sets the maximum seating count.
void	setMinimumSeats(long seats)	Sets the minimum seating count.
void	setNumber(String number)	Sets the program number.
void	setParentProgramOffering(Id programOfferingId)	Sets the parent program offering.
void	setRequiresRegistration(boolean requiresRegistration)	Sets the requires registration flag.
void	setRestrictedAudiences(Id[] resourceIds)	Sets the restricted audiences.
void	setSponsors(Id[] sponsorIds)	Sets the sponsors.
void	setTitle(String title)	Sets the title.
void	setURL(String url)	Sets the url for a program web site.

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.