Interface ScheduleSlotBatchForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidContainableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, ScheduleSlotForm, Suppliable

public interface ScheduleSlotBatchForm
extends ScheduleSlotForm

This is the form for creating and updating schedule slots in bulk. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ScheduleSlotBatchAdminSession . 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	getEventId()	Gets the Event Id of the schedule slot 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 OsidContainableForm

clearSequestered, getSequesteredMetadata, setSequestered

Modifier and Type	Method	Description
void	clearSequestered()	Clears the sequestered flag.
Metadata	getSequesteredMetadata()	Gets the metadata for the sequestered flag.
void	setSequestered(boolean sequestered)	Sets the sequestered flag.

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 ScheduleSlotForm

clearDuration, clearFixedInterval, clearWeekdaySchedule, getDurationMetadata, getFixedIntervalMetadata, getScheduleSlotFormRecord, getWeekdayMetadata, getWeekdayTimeMetadata, getWeeklyIntervalMetadata, getWeekOfMonthMetadata, setDuration, setFixedInterval, setWeekdays, setWeekdayTime, setWeeklyInterval, setWeekOfMonth

Modifier and Type	Method	Description
void	clearDuration()	Clears the duration terms.
void	clearFixedInterval()	Clears the fixed interval items.
void	clearWeekdaySchedule()	Clears the weekday schedule items.
Metadata	getDurationMetadata()	Gets the metadata for the duration of the slot.
Metadata	getFixedIntervalMetadata()	Gets the metadata for the fixed interval.
ScheduleSlotFormRecord	getScheduleSlotFormRecord(Type scheduleSlotRecordType)	Gets the ScheduleSlotFormRecord corresponding to the given schedule record Type .
Metadata	getWeekdayMetadata()	Gets the metadata for the weekdays of a weekly schedule.
Metadata	getWeekdayTimeMetadata()	Gets the metadata for the weekday time of a weekly schedule.
Metadata	getWeeklyIntervalMetadata()	Gets the metadata for the interval of a weekly schedule.
Metadata	getWeekOfMonthMetadata()	Gets the metadata for the week of the month of a weekly schedule.
void	setDuration(Duration duration)	Sets the duration.
void	setFixedInterval(Duration interval)	Sets the fixed interval.
void	setWeekdays(long[] weekdays)	Sets the weekdays of a weekly schedule.
void	setWeekdayTime(Time time)	Sets the weekday time of a weekly schedule.
void	setWeeklyInterval(long interval)	Sets the interval of a weekly schedule.
void	setWeekOfMonth(long week)	Sets the week of the month of a weekly schedule.

Method Details

getEventId

Id getEventId()

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

Returns:

the event Id

Throws:

IllegalStateException - isForUpdate() is true

Compliance:

mandatory - This method must be implemented.