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