OSID Logo
OSID Specifications
contact rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.contact.rules.ContactEnablerSearch
Implementsosid.OsidSearch
Description

The search interface for governing contact enabler searches.

MethodsearchAmongContactEnablers
Description

Execute this search among the given list of contact enablers.

Parametersosid.id.IdListcontactEnablerIdslist of contact enablers
ErrorsNULL_ARGUMENT contactEnablerIds is null
CompliancemandatoryThis method must be implemented.
MethodorderContactEnablerResults
Description

Specify an ordering to the search results.

Parametersosid.contact.rules.ContactEnablerSearchOrdercontactEnablerSearchOrdercontact enabler search order
ErrorsNULL_ARGUMENT contactEnablerSearchOrder is null
UNSUPPORTED contactEnablerSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetContactEnablerSearchRecord
Description

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

Parametersosid.type.TypecontactEnablerSearchRecordTypea contact enabler search record type
Returnosid.contact.rules.records.ContactEnablerSearchRecordthe contact enabler search record
ErrorsNULL_ARGUMENT contactEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(contactEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.