OSID Logo
OSID Specifications
subscription rules package
Version 3.1.0
Interfaceosid.subscription.rules.SubscriptionEnablerSearch
Implementsosid.OsidSearch
Used Byosid.subscription.rules.SubscriptionEnablerSearchSession
Description

The search interface for governing subscription enabler searches.

MethodsearchAmongSubscriptionEnablers
Description

Execute this search among the given list of subscription enablers.

Parametersosid.id.IdListsubscriptionEnablerIds list of subscription enablers
ErrorsNULL_ARGUMENT subscriptionEnablerIds is null
Compliancemandatory This method must be implemented.
MethodorderSubscriptionEnablerResults
Description

Specify an ordering to the search results.

Parametersosid.subscription.rules.SubscriptionEnablerSearchOrdersubscriptionEnablerSearchOrder subscription enabler search order
ErrorsNULL_ARGUMENT subscriptionEnablerSearchOrder is null
UNSUPPORTED subscriptionEnablerSearchOrder is not of this service
Compliancemandatory This 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.TypesubscriptionEnablerSearchRecordType a subscription enabler search record type
Returnosid.subscription.rules.records.SubscriptionEnablerSearchRecord the subscription enabler search record
ErrorsNULL_ARGUMENT subscriptionEnablerSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(subscriptionEnablerSearchRecordType) is false
Compliancemandatory This method must be implemented.