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

The search interface for governing commitment enabler searches.

MethodsearchAmongCommitmentEnablers
Description

Execute this search among the given list of commitment enablers.

Parametersosid.id.IdListcommitmentEnablerIdslist of commitment enablers
ErrorsNULL_ARGUMENT commitmentEnablerIds is null
CompliancemandatoryThis method must be implemented.
MethodorderCommitmentEnablerResults
Description

Specify an ordering to the search results.

Parametersosid.calendaring.rules.CommitmentEnablerSearchOrdercommitmentEnablerSearchOrdercommitment enabler search order
ErrorsNULL_ARGUMENT commitmentEnablerSearchOrder is null
UNSUPPORTED commitmentEnablerSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetCommitmentEnablerSearchRecord
Description

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

Parametersosid.type.TypecommitmentEnablerSearchRecordTypea commitment enabler search record type
Returnosid.calendaring.rules.records.CommitmentEnablerSearchRecordthe commitment enabler search record
ErrorsNULL_ARGUMENT commitmentEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(commitmentEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.