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

CommitmentSearch defines the interface for specifying commitment search options.

MethodsearchAmongCommitments
Description

Execute this search among the given list of commitments.

Parametersosid.id.IdListcommitmentIdslist of commitments
ErrorsNULL_ARGUMENT commitmentIds is null
CompliancemandatoryThis method must be implemented.
MethodorderCommitmentResults
Description

Specify an ordering to the search results.

Parametersosid.calendaring.CommitmentSearchOrdercommitmentSearchOrdercommitment search order
ErrorsNULL_ARGUMENT commitmentSearchOrder is null
UNSUPPORTED commitmentSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetCommitmentSearchRecord
Description

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

Parametersosid.type.TypecommitmentSearchRecordTypea commitment search record type
Returnosid.calendaring.records.CommitmentSearchRecordthe commitment search record
ErrorsNULL_ARGUMENT commitmentRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(commitmentSearchRecordType) is false
CompliancemandatoryThis method must be implemented.