OSID Logo
OSID Specifications
subscription rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.subscription.rules.SubscriptionEnablerSearch
Implementsosid.OsidSearch
Description

The search interface for governing subscription enabler searches.

MethodsearchAmongSubscriptionEnablers
Description

Execute this search among the given list of subscription enablers.

Parametersosid.id.IdListsubscriptionEnablerIdslist of subscription enablers
ErrorsNULL_ARGUMENT subscriptionEnablerIds is null
CompliancemandatoryThis method must be implemented.
MethodorderSubscriptionEnablerResults
Description

Specify an ordering to the search results.

Parametersosid.subscription.rules.SubscriptionEnablerSearchOrdersubscriptionEnablerSearchOrdersubscription enabler search order
ErrorsNULL_ARGUMENT subscriptionEnablerSearchOrder is null
UNSUPPORTED subscriptionEnablerSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetSubscriptionEnablerSearchRecord
Description

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

Parametersosid.type.TypesubscriptionEnablerSearchRecordTypea subscription enabler search record type
Returnosid.subscription.rules.records.SubscriptionEnablerSearchRecordthe subscription enabler search record
ErrorsNULL_ARGUMENT subscriptionEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(subscriptionEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.