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.
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.
|
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
clearSequestered, getSequesteredMetadata, setSequestered
Metadata getWeekdayMetadata()
mandatory
- This method must be implemented. void setWeekdays(long[] weekdays)
weekdays
- the new weekday setInvalidArgumentException
- weekdays
is
invalidNoAccessException
- weekdays
cannot be
modifiedNullArgumentException
- weekdays
is
null
mandatory
- This method must be implemented. Metadata getWeeklyIntervalMetadata()
mandatory
- This method must be implemented. void setWeeklyInterval(long interval)
interval
- the new weekly intervalInvalidArgumentException
- interval
is
invalidNoAccessException
- interval
cannot be
modifiedmandatory
- This method must be implemented. Metadata getWeekOfMonthMetadata()
mandatory
- This method must be implemented. void setWeekOfMonth(long week)
week
- the new week of the monthInvalidArgumentException
- week
is
invalidNoAccessException
- week
cannot be
modifiedmandatory
- This method must be implemented. Metadata getWeekdayTimeMetadata()
mandatory
- This method must be implemented. void setWeekdayTime(Time time)
time
- the new timeInvalidArgumentException
- time
is
invalidNoAccessException
- time
cannot be
modifiedNullArgumentException
- time
is
null
mandatory
- This method must be implemented. void clearWeekdaySchedule()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getFixedIntervalMetadata()
mandatory
- This method must be implemented. void setFixedInterval(Duration interval)
interval
- the new fixed intervalInvalidArgumentException
- interval
is
invalidNoAccessException
- interval
cannot be
modifiedNullArgumentException
- interval
is
null
mandatory
- This method must be implemented. void clearFixedInterval()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getDurationMetadata()
mandatory
- This method must be implemented. void setDuration(Duration duration)
duration
- the new durationInvalidArgumentException
- duration
is
invalidNoAccessException
- duration
cannot be
modifiedNullArgumentException
- duration
is
null
mandatory
- This method must be implemented. void clearDuration()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. ScheduleSlotFormRecord getScheduleSlotFormRecord(Type scheduleSlotRecordType) throws OperationFailedException
ScheduleSlotFormRecord
corresponding to the
given schedule record Type.
scheduleSlotRecordType
- the schedule slot record typeNullArgumentException
- scheduleSlotRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(scheduleSlotRecordType)
is false
mandatory
- This method must be implemented.