org.osid.calendaring.cycle

Interface CyclicTimePeriod

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject

public interface CyclicTimePeriod
extends OsidObject

A CyclicTimePeriod represents a canonical span of time.

Method Summary

Methods

Modifier and Type	Method and Description
CyclicTimePeriodRecord	getCyclicTimePeriodRecord(Type cyclicTimePeriodRecordType) Gets the cyclic time period record corresponding to the given CyclicTimePeriod 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

getCyclicTimePeriodRecord

CyclicTimePeriodRecord getCyclicTimePeriodRecord(Type cyclicTimePeriodRecordType)
                                                 throws OperationFailedException

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

Parameters:

cyclicTimePeriodRecordType - the type of the record to retrieve

Returns:

the cyclic time period record

Throws:

NullArgumentException - cyclicTimePeriodRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(cyclicTimePeriodRecordType) is false

Compliance:

mandatory - This method must be implemented.