Interface ScheduleBatchForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, ScheduleForm, Suppliable

public interface ScheduleBatchForm
extends ScheduleForm

This is the form for creating and updating schedules in bulk. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ScheduleBatchAdminSession . 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	getScheduleId()	Gets the Id of the schedule to be updated if this is an update transaction.
Id	getScheduleSlotId()	Gets the ScheduleSlot Id of the schedule if this is a create transaction.
Id	getTimePeriodId()	Gets the time period Id of the schedule 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 ScheduleForm

clearLimit, clearLocation, clearLocationDescription, clearScheduleEnd, clearScheduleSlot, clearScheduleStart, clearTimePeriod, getLimitMetadata, getLocationMetadata, getScheduleEndMetadata, getScheduleSlotFormRecord, getScheduleSlotMetadata, getScheduleStartMetadata, getTimePeriodMetadata, setLimit, setLocation, setLocationDescription, setScheduleEnd, setScheduleSlot, setScheduleStart, setTimePeriod

Modifier and Type	Method	Description
void	clearLimit()	Clears the limit.
void	clearLocation()	Clears the location.
void	clearLocationDescription()	Clears the location description.
void	clearScheduleEnd()	Clears the schedule end.
void	clearScheduleSlot()	Clears the schedule slot.
void	clearScheduleStart()	Clears the schedule start.
void	clearTimePeriod()	Clears the time period.
Metadata	getLimitMetadata()	Gets the metadata for the weekdays of a weekly schedule.
Metadata	getLocationMetadata()	Gets the metadata for a location.
Metadata	getScheduleEndMetadata()	Gets the metadata for the schedule end date.
ScheduleFormRecord	getScheduleSlotFormRecord(Type scheduleRecordType)	Gets the ScheduleFormRecord corresponding to the given schedule record Type .
Metadata	getScheduleSlotMetadata()	Gets the metadata for the schedule slot.
Metadata	getScheduleStartMetadata()	Gets the metadata for the schedule start date.
Metadata	getTimePeriodMetadata()	Gets the metadata for the time period.
void	setLimit(long[] weekdays)	Sets the weekdays of a weekly schedule.
void	setLocation(Id locationId)	Sets the location.
void	setLocationDescription(String location)	Sets the location description.
void	setScheduleEnd(DateTime start)	Sets the schedule end date.
void	setScheduleSlot(Id scheduleSlotId)	Sets the schedule slot.
void	setScheduleStart(DateTime start)	Sets the schedule start date.
void	setTimePeriod(Id timePeriodId)	Sets the time period.

Method Details

getScheduleSlotId

Id getScheduleSlotId()

Gets the ScheduleSlot Id of the schedule if this is a create transaction.

Returns:

the schedule slot Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getTimePeriodId

Id getTimePeriodId()

Gets the time period Id of the schedule if this is a create transaction.

Returns:

the time period Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.

getScheduleId

Id getScheduleId()

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

Returns:

the schedule Id

Throws:

IllegalStateException - isForUpdate() is false

Compliance:

mandatory - This method must be implemented.