Interface ScheduleForm

All Superinterfaces:

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

All Known Subinterfaces:

ScheduleBatchForm

public interface ScheduleForm
extends OsidObjectForm

This is the form for creating and updating Schedules. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ScheduleAdminSession. 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
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.

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.

Method Details

getScheduleSlotMetadata

Metadata getScheduleSlotMetadata()

Gets the metadata for the schedule slot.

Returns:

metadata for the schedule slot

Compliance:

mandatory - This method must be implemented.

setScheduleSlot

void setScheduleSlot(Id scheduleSlotId)

Sets the schedule slot.

Parameters:

scheduleSlotId - the new schedule slot Id

Throws:

InvalidArgumentException - scheduleSlotId is invalid

NoAccessException - scheduleSlotId cannot be modified

NullArgumentException - scheduleSlotId is null

Compliance:

mandatory - This method must be implemented.

clearScheduleSlot

void clearScheduleSlot()

Clears the schedule slot.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getTimePeriodMetadata

Metadata getTimePeriodMetadata()

Gets the metadata for the time period.

Returns:

metadata for the time period

Compliance:

mandatory - This method must be implemented.

setTimePeriod

void setTimePeriod(Id timePeriodId)

Sets the time period.

Parameters:

timePeriodId - the new time period Id

Throws:

InvalidArgumentException - timePeriodId is invalid

NoAccessException - timePeriodId cannot be modified

NullArgumentException - timePeriodId is null

Compliance:

mandatory - This method must be implemented.

clearTimePeriod

void clearTimePeriod()

Clears the time period.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getScheduleStartMetadata

Metadata getScheduleStartMetadata()

Gets the metadata for the schedule start date.

Returns:

metadata for the schedule start

Compliance:

mandatory - This method must be implemented.

setScheduleStart

void setScheduleStart(DateTime start)

Sets the schedule start date. This may be set in lieu of a time period to set a specific date range.

Parameters:

start - the new start date

Throws:

InvalidArgumentException - start is invalid

NoAccessException - start cannot be modified

NullArgumentException - start is null

Compliance:

mandatory - This method must be implemented.

clearScheduleStart

void clearScheduleStart()

Clears the schedule start.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getScheduleEndMetadata

Metadata getScheduleEndMetadata()

Gets the metadata for the schedule end date.

Returns:

metadata for the schedule end

Compliance:

mandatory - This method must be implemented.

setScheduleEnd

void setScheduleEnd(DateTime start)

Sets the schedule end date. This may be set in lieu of a time period to set a specific date range.

Parameters:

start - the new end date

Throws:

InvalidArgumentException - end is invalid

NoAccessException - end cannot be modified

NullArgumentException - end is null

Compliance:

mandatory - This method must be implemented.

clearScheduleEnd

void clearScheduleEnd()

Clears the schedule end.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getLimitMetadata

Metadata getLimitMetadata()

Gets the metadata for the weekdays of a weekly schedule.

Returns:

metadata for the weekday

Compliance:

mandatory - This method must be implemented.

setLimit

void setLimit(long[] weekdays)

Sets the weekdays of a weekly schedule.

Parameters:

weekdays - the new weekday set

Throws:

InvalidArgumentException - weekdays is invalid

NoAccessException - weekdays cannot be modified

NullArgumentException - weekdays is null

Compliance:

mandatory - This method must be implemented.

clearLimit

void clearLimit()

Clears the limit.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

setLocationDescription

void setLocationDescription(String location)

Sets the location description.

Parameters:

location - the new location description

Throws:

InvalidArgumentException - location is invalid

NoAccessException - location cannot be modified

NullArgumentException - location is null

Compliance:

mandatory - This method must be implemented.

clearLocationDescription

void clearLocationDescription()

Clears the location description.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getLocationMetadata

Metadata getLocationMetadata()

Gets the metadata for a location.

Returns:

metadata for the location

Compliance:

mandatory - This method must be implemented.

setLocation

void setLocation(Id locationId)

Sets the location.

Parameters:

locationId - the new location

Throws:

InvalidArgumentException - locationId is invalid

NoAccessException - locationId cannot be modified

NullArgumentException - locationId is null

Compliance:

mandatory - This method must be implemented.

clearLocation

void clearLocation()

Clears the location.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getScheduleSlotFormRecord

ScheduleFormRecord getScheduleSlotFormRecord(Type scheduleRecordType)
                                      throws OperationFailedException

Gets the ScheduleFormRecord corresponding to the given schedule record Type.

Parameters:

scheduleRecordType - the schedule record type

Returns:

the schedule form record

Throws:

NullArgumentException - scheduleRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(scheduleRecordType) is false

Compliance:

mandatory - This method must be implemented.