public interface ScheduleSlot extends OsidObject, Containable
A ScheduleSlot
describes a repeating time slot. The time
slot can be defined as a fixed time interval or be defined on a weekly
interval specifying the days of the week.
Modifier and Type | Method and Description |
---|---|
Duration |
getDuration()
Gets the duration of the schedule slot.
|
Duration |
getFixedInterval()
Gets the repeating interval.
|
IdList |
getScheduleSlotIds()
Gets the
Ids of the schedule slots included inside this
one. |
ScheduleSlotRecord |
getScheduleSlotRecord(Type scheduleSlotRecordType)
Gets the schedule slot record corresponding to the given
ScheduleSlot record Type. |
ScheduleSlotList |
getScheduleSlots()
Gets the schedule slots included inside this one.
|
long[] |
getWeekdays()
Gets the weekdays of the schedule.
|
Time |
getWeekdayTime()
Gets the time of this recurring schedule.
|
long |
getWeeklyInterval()
Gets the number of weeks of the interval.
|
long |
getWeekOfMonth()
Gets the week of the month for the interval.
|
boolean |
hasFixedInterval()
Tests if this schedule has a fixed time interval.
|
boolean |
hasWeeklyInterval()
Tests if this schedule has a weekly interval.
|
boolean |
hasWeekOfMonthInterval()
Tests if this schedule has a weekly interval based on the week of the
month.
|
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
isSequestered
IdList getScheduleSlotIds()
Ids
of the schedule slots included inside this
one. Ids
mandatory
- This method must be implemented. ScheduleSlotList getScheduleSlots() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean hasWeeklyInterval()
true,
hasFixedInterval()
must be false.
true
if there is a weekly interval,
false
otherwisemandatory
- This method must be implemented. long[] getWeekdays()
IllegalStateException
- hasWeeklyInterval()
is false
mandatory
- This method must be implemented. boolean hasWeekOfMonthInterval()
false
if
hasWeeklyInterval()
is false.
true
if there is a week of month specified,
false
otherwisemandatory
- This method must be implemented. long getWeeklyInterval()
the week interval
IllegalStateException
- hasWeekdlyInterval()
is false
or
hasWeekofMonthInterval()
is true
mandatory
- This method must be implemented. long getWeekOfMonth()
the week interval
IllegalStateException
- hasWeeklyInterval()
is false
or
hasWeekofMonthInterval()
is false
mandatory
- This method must be implemented. Time getWeekdayTime()
IllegalStateException
- hasWeeklyInterval()
is false
mandatory
- This method must be implemented. boolean hasFixedInterval()
true
if there is a fixed time interval,
false
otherwisemandatory
- This method must be implemented. Duration getFixedInterval()
IllegalStateException
- hasFixedInterval()
is false
mandatory
- This method must be implemented. Duration getDuration()
mandatory
- This method must be implemented. ScheduleSlotRecord getScheduleSlotRecord(Type scheduleSlotRecordType) throws OperationFailedException
ScheduleSlot
record Type.
This method is used
to retrieve an object implementing the requested record. The
scheduleSlotRecordType
may be the Type
returned
in getRecordTypes()
or any of its parents in a
Type
hierarchy where
hasRecordType(scheduleSlotRecordType)
is true
.scheduleSlotRecordType
- the type of the record to retrieveNullArgumentException
- scheduleSlotRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(scheduleSlotRecordType)
is false
mandatory
- This method must be implemented.