Interface TimePeriod

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject

public interface TimePeriod
extends OsidObject

A TimePeriod represents a span of time in which recurring events are expanded.

Method Summary

Modifier and Type	Method	Description
DateTime	getEnd()	Gets the end time of the time period.
IdList	getExceptionIds()	Gets the exception Ids to this time period.
EventList	getExceptions()	Gets the exceptions to this time period.
DateTime	getStart()	Gets the start time of the time period.
TimePeriodRecord	getTimePeriodRecord(Type timePeriodRecordType)	Gets the time period record corresponding to the given TimePeriod 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

getStart

DateTime getStart()

Gets the start time of the time period.

Returns:

the start time

Compliance:

mandatory - This method must be implemented.

getEnd

DateTime getEnd()

Gets the end time of the time period.

Returns:

the end time

Compliance:

mandatory - This method must be implemented.

getExceptionIds

IdList getExceptionIds()

Gets the exception Ids to this time period. Recurring events overlapping with these events do not appear in any recurring event for this time period.

Returns:

list of exception event Ids

Compliance:

mandatory - This method must be implemented.

getExceptions

EventList getExceptions()
                 throws OperationFailedException

Gets the exceptions to this time period. Recurring events overlapping with these events do not appear in any recurring event for this time period.

Returns:

event exceptions

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getTimePeriodRecord

TimePeriodRecord getTimePeriodRecord(Type timePeriodRecordType)
                              throws OperationFailedException

Gets the time period record corresponding to the given TimePeriod record Type . This method is used to retrieve an object implementing the requested record. The timePeriodRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(timePeriodRecordType) is true .

Parameters:

timePeriodRecordType - the type of the record to retrieve

Returns:

the time period record

Throws:

NullArgumentException - timePeriodRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(timePeriodRecordType) is false

Compliance:

mandatory - This method must be implemented.