public interface Schedule extends OsidObject
A Schedule
is a scheduled time slot offered within a
time interval at a location. The time interval may be inferred from an
associated TimePeriod
or managed explicitly without a
TimePeriod.
Modifier and Type | Method and Description |
---|---|
long |
getLimit()
Gets the limit of the number of occurences of this schedule.
|
Location |
getLocation()
Gets the
Location. |
DisplayText |
getLocationDescription()
Gets a descriptive location.
|
Id |
getLocationId()
Gets the location
Id . |
DateTime |
getScheduleEnd()
Gets the end date of this schedule.
|
ScheduleRecord |
getScheduleRecord(Type scheduleRecordType)
Gets the schedule record corresponding to the given
Schedule
record Type. |
ScheduleSlot |
getScheduleSlot()
Gets the schedule slot included inside this one.
|
Id |
getScheduleSlotId()
Gets the
Id of the schedule slot. |
DateTime |
getScheduleStart()
Gets the start date of this schedule.
|
TimePeriod |
getTimePeriod()
Gets the
TimePeriod for this recurring event. |
Id |
getTimePeriodId()
Gets the
TimePeriod Id for this recurring event. |
Duration |
getTotalDuration()
Gets a total duration for the entire schedule based on the duration of
schedule slots and span of the schedule.
|
boolean |
hasLimit()
Tests if this schedule has a limit on the number of occurrences.
|
boolean |
hasLocation()
Tests if a location is associated with this event.
|
boolean |
hasTimePeriod()
Tests if a
TimePeriod is associated with this schedule. |
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
Id getScheduleSlotId()
Id
of the schedule slot. Id
mandatory
- This method must be implemented. ScheduleSlot getScheduleSlot() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean hasTimePeriod()
TimePeriod
is associated with this schedule.
The time period determines the start and end time of the recurring
series. true
if there is an associated
TimePeriod,
false
otherwisemandatory
- This method must be implemented. Id getTimePeriodId()
TimePeriod Id
for this recurring event. A
Schedule
with an associated TimePeriod
overrides any start or end date set. Id
IllegalStateException
- hasTimePeriod()
is false
mandatory
- This method must be implemented. TimePeriod getTimePeriod() throws OperationFailedException
TimePeriod
for this recurring event. A
Schedule
with an associated TimePeriod
overrides any start or end date set.IllegalStateException
- hasTimePeriod()
is false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. DateTime getScheduleStart()
hasTimePeriod()
is true,
the start date is the start date of
the associated TimePeriod.
mandatory
- This method must be implemented. DateTime getScheduleEnd()
hasTimePeriod()
is true,
the end date is the end date of the associated
TimePeriod.
mandatory
- This method must be implemented. boolean hasLimit()
true
if there is a limit false
otherwisemandatory
- This method must be implemented. long getLimit()
IllegalStateException
- hasLimitl()
is
false
mandatory
- This method must be implemented. DisplayText getLocationDescription()
mandatory
- This method must be implemented. boolean hasLocation()
true
if there is an associated location,
false
otherwisemandatory
- This method must be implemented. Id getLocationId()
Id
. Id
IllegalStateException
- hasLocation()
is
false
mandatory
- This method must be implemented. Location getLocation() throws OperationFailedException
Location.
IllegalStateException
- hasLocation()
is
false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Duration getTotalDuration()
mandatory
- This method must be implemented. ScheduleRecord getScheduleRecord(Type scheduleRecordType) throws OperationFailedException
Schedule
record Type.
This method is used to retrieve an
object implementing the requested record. The
scheduleRecordType
may be the Type
returned in
getRecordTypes()
or any of its parents in a Type
hierarchy where hasRecordType(scheduleRecordType)
is true
.scheduleRecordType
- the type of the record to retrieveNullArgumentException
- scheduleRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(scheduleRecordType)
is false
mandatory
- This method must be implemented.