Interface CyclicTimePeriod

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject

public interface CyclicTimePeriod
extends OsidObject

A CyclicTimePeriod represents a canonical span of time.

Method Summary

Modifier and Type	Method	Description
CyclicTimePeriodRecord	getCyclicTimePeriodRecord(Type cyclicTimePeriodRecordType)	Gets the cyclic time period record corresponding to the given CyclicTimePeriod record Type.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Modifier and Type	Method	Description
DisplayText	getDescription()	Gets the description associated with this instance of this OSID object.
DisplayText	getDisplayName()	Gets the preferred display name associated with this instance of this OSID object appropriate for display to the user.
Type	getGenusType()	Gets the genus type of this object.
boolean	isOfGenusType(Type genusType)	Tests if this object is of the given genus Type.

Method Details

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.