public interface TimePeriod extends OsidObject
A TimePeriod
represents a span of time in which
recurring events are expanded.
Modifier and Type | Method and Description |
---|---|
DateTime |
getEnd()
Gets the end time of the time period.
|
IdList |
getExceptionIds()
Gets the exception
Ids to this time period. |
EventList |
getExceptions()
Gets the exceptions to this time period.
|
DateTime |
getStart()
Gets the start time of the time period.
|
TimePeriodRecord |
getTimePeriodRecord(Type timePeriodRecordType)
Gets the time period record corresponding to the given
TimePeriod record Type. |
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
DateTime getStart()
mandatory
- This method must be implemented. DateTime getEnd()
mandatory
- This method must be implemented. IdList getExceptionIds()
Ids
to this time period. Recurring
events overlapping with these events do not appear in any recurring
event for this time period. Ids
mandatory
- This method must be implemented. EventList getExceptions() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. TimePeriodRecord getTimePeriodRecord(Type timePeriodRecordType) throws OperationFailedException
TimePeriod
record Type.
This method is used to
retrieve an object implementing the requested record. The
timePeriodRecordType
may be the Type
returned
in getRecordTypes()
or any of its parents in a
Type
hierarchy where
hasRecordType(timePeriodRecordType)
is true
.timePeriodRecordType
- the type of the record to retrieveNullArgumentException
- timePeriodRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(timePeriodRecordType)
is false
mandatory
- This method must be implemented.