Interface CourseOfferingBatchForm

All Superinterfaces:

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

public interface CourseOfferingBatchForm
extends CourseOfferingForm

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

Methods inherited from interface CourseOfferingForm

clearCreditAmounts, clearEvent, clearGradingOptions, clearInstructors, clearLearningObjectives, clearLevels, clearMaximumSeats, clearMinimumSeats, clearNumber, clearPrerequisites, clearPrerequisitesInfo, clearRequiresRegistration, clearRestrictedAudiences, clearScheduleInfo, clearSponsors, clearTitle, clearURL, getCourseOfferingFormRecord, getCreditAmountsMetadata, getEventMetadata, getGradingOptionsMetadata, getInstructorsMetadata, getLearningObjectivesMetadata, getLevelsMetadata, getMaximumSeatsMetadata, getMinimumSeatsMetadata, getNumberMetadata, getPrerequisitesInfoMetadata, getPrerequisitesMetadata, getRequiresRegistrationMetadata, getRestrictedAudiencesMetadata, getScheduleInfoMetadata, getSponsorsMetadata, getTitleMetadata, getURLMetadata, setCreditAmounts, setEvent, setGradingOptions, setInstructors, setLearningObjectives, setLevels, setMaximumSeats, setMinimumSeats, setNumber, setPrerequisites, setPrerequisitesInfo, setRequiresRegistration, setRestrictedAudiences, setScheduleInfo, setSponsors, setTitle, setURL

Modifier and Type	Method	Description
void	clearCreditAmounts()	Removes the credits.
void	clearEvent()	Removes the event.
void	clearGradingOptions()	Removes the grading options.
void	clearInstructors()	Removes the instructors.
void	clearLearningObjectives()	Removes the learning objectives.
void	clearLevels()	Removes the grade levels.
void	clearMaximumSeats()	Removes the maximum seats.
void	clearMinimumSeats()	Removes the minimum seats.
void	clearNumber()	Removes the course number.
void	clearPrerequisites()	Removes the prerequisites.
void	clearPrerequisitesInfo()	Removes the prerequisite information.
void	clearRequiresRegistration()	Removes the requires registration flag.
void	clearRestrictedAudiences()	Removes the restricted audiences.
void	clearScheduleInfo()	Removes the schedule info.
void	clearSponsors()	Removes the sponsors.
void	clearTitle()	Removes the title.
void	clearURL()	Removes the url.
CourseOfferingFormRecord	getCourseOfferingFormRecord(Type courseOfferingRecordType)	Gets the CourseOfferingFormRecord corresponding to the given course offering record Type .
Metadata	getCreditAmountsMetadata()	Gets the metadata for the credits.
Metadata	getEventMetadata()	Gets the metadata for manually linking an event.
Metadata	getGradingOptionsMetadata()	Gets the metadata for the grading options.
Metadata	getInstructorsMetadata()	Gets the metadata for the instructors.
Metadata	getLearningObjectivesMetadata()	Gets the metadata for a set of learning objectives.
Metadata	getLevelsMetadata()	Gets the metadata for a set of grade levels.
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 course number.
Metadata	getPrerequisitesInfoMetadata()	Gets the metadata for a course offering prerequisite informational string.
Metadata	getPrerequisitesMetadata()	Gets the metadata for prerequisites.
Metadata	getRequiresRegistrationMetadata()	Gets the metadata for requires registration flag.
Metadata	getRestrictedAudiencesMetadata()	Gets the metadata for a set of restricted audiences.
Metadata	getScheduleInfoMetadata()	Gets the metadata for a schedule informatoin string.
Metadata	getSponsorsMetadata()	Gets the metadata for the sponsors.
Metadata	getTitleMetadata()	Gets the metadata for a course title.
Metadata	getURLMetadata()	Gets the metadata for a class url.
void	setCreditAmounts(Id[] gradeIds)	Sets the credits.
void	setEvent(Id eventId)	Sets the event.
void	setGradingOptions(Id[] gradeSystemIds)	Sets the grading options.
void	setInstructors(Id[] resourceIds)	Sets the instructors.
void	setLearningObjectives(Id[] objectiveIds)	Sets the learning objectives.
void	setLevels(Id[] gradeIds)	Sets the levels.
void	setMaximumSeats(long seats)	Sets the maximum seating count.
void	setMinimumSeats(long seats)	Sets the minimum seating count.
void	setNumber(String number)	Sets the course number.
void	setPrerequisites(Id[] requisiteIds)	Sets the prerequisites.
void	setPrerequisitesInfo(String prereqInfo)	Sets the prerequisitie information.
void	setRequiresRegistration(boolean requiresRegistration)	Sets the requires registration flag.
void	setRestrictedAudiences(Id[] resourceIds)	Sets the restricted audiences.
void	setScheduleInfo(String scheduleInfo)	Sets the schedule information.
void	setSponsors(Id[] sponsorIds)	Sets the sponsors.
void	setTitle(String title)	Sets the title.
void	setURL(String url)	Sets the url for a class web site.

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.

Method Details

getCourseId

Id getCourseId()

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

Returns:

the course Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getTermId

Id getTermId()

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

Returns:

the term Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getCourseOfferingId

Id getCourseOfferingId()

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

Returns:

the course offering Id

Throws:

IllegalStateException - isForUpdate() is false

Compliance:

mandatory - This method must be implemented.