OSID Logo
OSID Specifications
contact rules package
Version 3.1.0
Interfaceosid.contact.rules.ContactEnablerSearch
Implementsosid.OsidSearch
Used Byosid.contact.rules.ContactEnablerSearchSession
Description

The search interface for governing contact enabler searches.

MethodsearchAmongContactEnablers
Description

Execute this search among the given list of contact enablers.

Parametersosid.id.IdListcontactEnablerIds list of contact enablers
ErrorsNULL_ARGUMENT contactEnablerIds is null
Compliancemandatory This method must be implemented.
MethodorderContactEnablerResults
Description

Specify an ordering to the search results.

Parametersosid.contact.rules.ContactEnablerSearchOrdercontactEnablerSearchOrder contact enabler search order
ErrorsNULL_ARGUMENT contactEnablerSearchOrder is null
UNSUPPORTED contactEnablerSearchOrder is not of this service
Compliancemandatory This 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.TypecontactEnablerSearchRecordType a contact enabler search record type
Returnosid.contact.rules.records.ContactEnablerSearchRecord the contact enabler search record
ErrorsNULL_ARGUMENT contactEnablerSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(contactEnablerSearchRecordType) is false
Compliancemandatory This method must be implemented.