OSID Logo
OSID Specifications
calendaring package
Version 3.1.0
Interfaceosid.calendaring.TimePeriod
Implementsosid.OsidObject
Used Byosid.OsidEnabler
osid.OsidRuleApplicator
osid.calendaring.Schedule
osid.calendaring.TimePeriodAdminSession
osid.calendaring.TimePeriodList
osid.calendaring.TimePeriodLookupSession
osid.offering.Offering
osid.offering.Participant
osid.recognition.Convocation
Description

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

MethodgetStart
Description

Gets the start time of the time period.

Returnosid.calendaring.DateTime the start time
Compliancemandatory This method must be implemented.
MethodgetEnd
Description

Gets the end time of the time period.

Returnosid.calendaring.DateTime the end time
Compliancemandatory This method must be implemented.
MethodgetExceptionIds
Description

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.

Returnosid.id.IdList list of exception event Ids
Compliancemandatory This method must be implemented.
MethodgetExceptions
Description

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

Returnosid.calendaring.EventList event exceptions
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetTimePeriodRecord
Description

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.

Parametersosid.type.TypetimePeriodRecordType the type of the record to retrieve
Returnosid.calendaring.records.TimePeriodRecord the time period record
ErrorsNULL_ARGUMENT timePeriodRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(timePeriodRecordType) is false
Compliancemandatory This method must be implemented.