org.osid.calendaring.cycle

Interface CyclicEvent

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject

public interface CyclicEvent
extends OsidObject

An CyclicEvent represents canonical event.

Method Summary

Methods

Modifier and Type	Method and Description
CyclicEventRecord	getCyclicEventRecord(Type cyclicEventRecordType) Gets the cyclic event record corresponding to the given CyclicEvent record Type.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getCyclicEventRecord

CyclicEventRecord getCyclicEventRecord(Type cyclicEventRecordType)
                                       throws OperationFailedException

Gets the cyclic event record corresponding to the given 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 .

Parameters:

cyclicEventRecordType - the type of the record to retrieve

Returns:

the cyclic event record

Throws:

NullArgumentException - cyclicEventRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(cyclicEventRecordType) is false

Compliance:

mandatory - This method must be implemented.