OSID Logo
OSID Specifications
control rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.rules.TriggerEnablerSearch
Implementsosid.OsidSearch
Description

The search interface for governing trigger enabler searches.

MethodsearchAmongTriggerEnablers
Description

Execute this search among the given list of trigger enablers.

Parametersosid.id.IdListtriggerEnablerIdslist of trigger enablers
ErrorsNULL_ARGUMENT triggerEnablerIds is null
CompliancemandatoryThis method must be implemented.
MethodorderTriggerEnablerResults
Description

Specify an ordering to the search results.

Parametersosid.control.rules.TriggerEnablerSearchOrdertriggerEnablerSearchOrdertrigger enabler search order
ErrorsNULL_ARGUMENT triggerEnablerSearchOrder is null
UNSUPPORTED triggerEnablerSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetTriggerEnablerSearchRecord
Description

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

Parametersosid.type.TypetriggerEnablerSearchRecordTypea trigger enabler search record type
Returnosid.control.rules.records.TriggerEnablerSearchRecordthe trigger enabler search record
ErrorsNULL_ARGUMENT triggerEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(triggerEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.