org.osid.calendaring

Interface ScheduleSlotForm

All Superinterfaces:

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

All Known Subinterfaces:

ScheduleSlotBatchForm

public interface ScheduleSlotForm
extends OsidObjectForm, OsidContainableForm

This is the form for creating and updating ScheduleSlots. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ScheduleSlotAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

Method Summary

Methods

Modifier and Type	Method and 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.

Methods inherited from interface org.osid.OsidObjectForm

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

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

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

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.OsidContainableForm

clearSequestered, getSequesteredMetadata, setSequestered

Method Detail

getWeekdayMetadata

Metadata getWeekdayMetadata()

Gets the metadata for the weekdays of a weekly schedule.

Returns:

metadata for the weekday

Compliance:

mandatory - This method must be implemented.

setWeekdays

void setWeekdays(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.

getWeeklyIntervalMetadata

Metadata getWeeklyIntervalMetadata()

Gets the metadata for the interval of a weekly schedule.

Returns:

metadata for the weekly interval

Compliance:

mandatory - This method must be implemented.

setWeeklyInterval

void setWeeklyInterval(long interval)

Sets the interval of a weekly schedule.

Parameters:

interval - the new weekly interval

Throws:

InvalidArgumentException - interval is invalid

NoAccessException - interval cannot be modified

Compliance:

mandatory - This method must be implemented.

getWeekOfMonthMetadata

Metadata getWeekOfMonthMetadata()

Gets the metadata for the week of the month of a weekly schedule.

Returns:

metadata for the week of the month

Compliance:

mandatory - This method must be implemented.

setWeekOfMonth

void setWeekOfMonth(long week)

Sets the week of the month of a weekly schedule.

Parameters:

week - the new week of the month

Throws:

InvalidArgumentException - week is invalid

NoAccessException - week cannot be modified

Compliance:

mandatory - This method must be implemented.

getWeekdayTimeMetadata

Metadata getWeekdayTimeMetadata()

Gets the metadata for the weekday time of a weekly schedule.

Returns:

metadata for the weekday time

Compliance:

mandatory - This method must be implemented.

setWeekdayTime

void setWeekdayTime(Time time)

Sets the weekday time of a weekly schedule.

Parameters:

time - the new time

Throws:

InvalidArgumentException - time is invalid

NoAccessException - time cannot be modified

NullArgumentException - time is null

Compliance:

mandatory - This method must be implemented.

clearWeekdaySchedule

void clearWeekdaySchedule()

Clears the weekday schedule items.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getFixedIntervalMetadata

Metadata getFixedIntervalMetadata()

Gets the metadata for the fixed interval.

Returns:

metadata for the fixed interval.

Compliance:

mandatory - This method must be implemented.

setFixedInterval

void setFixedInterval(Duration interval)

Sets the fixed interval.

Parameters:

interval - the new fixed interval

Throws:

InvalidArgumentException - interval is invalid

NoAccessException - interval cannot be modified

NullArgumentException - interval is null

Compliance:

mandatory - This method must be implemented.

clearFixedInterval

void clearFixedInterval()

Clears the fixed interval items.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getDurationMetadata

Metadata getDurationMetadata()

Gets the metadata for the duration of the slot.

Returns:

metadata for the duration

Compliance:

mandatory - This method must be implemented.

setDuration

void setDuration(Duration duration)

Sets the duration.

Parameters:

duration - the new duration

Throws:

InvalidArgumentException - duration is invalid

NoAccessException - duration cannot be modified

NullArgumentException - duration is null

Compliance:

mandatory - This method must be implemented.

clearDuration

void clearDuration()

Clears the duration terms.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getScheduleSlotFormRecord

ScheduleSlotFormRecord getScheduleSlotFormRecord(Type scheduleSlotRecordType)
                                                 throws OperationFailedException

Gets the ScheduleSlotFormRecord corresponding to the given schedule record Type.

Parameters:

scheduleSlotRecordType - the schedule slot record type

Returns:

the schedule slot form record

Throws:

NullArgumentException - scheduleSlotRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(scheduleSlotRecordType) is false

Compliance:

mandatory - This method must be implemented.