public interface CyclicTimePeriod extends OsidObject
A CyclicTimePeriod
represents a canonical span of time.
Modifier and Type | Method and Description |
---|---|
CyclicTimePeriodRecord |
getCyclicTimePeriodRecord(Type cyclicTimePeriodRecordType)
Gets the cyclic time period record corresponding to the given
CyclicTimePeriod record Type. |
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
CyclicTimePeriodRecord getCyclicTimePeriodRecord(Type cyclicTimePeriodRecordType) throws OperationFailedException
CyclicTimePeriod
record Type.
This method is
used to retrieve an object implementing the requested record. The
cyclicTimePeriodRecordType
may be the Type
returned in getRecordTypes()
or any of its
parents in a Type
hierarchy where
hasRecordType(cyclicTimePeriodRecordType)
is true
.cyclicTimePeriodRecordType
- the type of the record to retrieveNullArgumentException
-
cyclicTimePeriodRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(cyclicTimePeriodRecordType)
is
false
mandatory
- This method must be implemented.