OSID Logo
OSID Specifications
calendaring package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.TimePeriodSearch
Implementsosid.OsidSearch
Description

TimePeriodSearch defines the interface for specifying time period search options.

MethodsearchAmongTimePeriods
Description

Execute this search among the given list of time periods.

Parametersosid.id.IdListtimePeriodIdslist of time periods
ErrorsNULL_ARGUMENT timePeriodIds is null
CompliancemandatoryThis method must be implemented.
MethodorderTimePeriodResults
Description

Specify an ordering to the search results.

Parametersosid.calendaring.TimePeriodSearchOrdertimePeriodSearchOrdertime period search order
ErrorsNULL_ARGUMENT timePeriodSearchOrder is null
UNSUPPORTED timePeriodSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetTimePeriodSearchRecord
Description

Gets the time period search record corresponding to the given time period search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypetimePeriodSearchRecordTypea time period search record type
Returnosid.calendaring.records.TimePeriodSearchRecordthe time period search record
ErrorsNULL_ARGUMENT timePeriodSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(timePeriodSearchRecordType) is false
CompliancemandatoryThis method must be implemented.