OSID Logo
OSID Specifications
subscription rules package
Version 3.0.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.IdListsubscriptionEnablerIdslist of subscription enablers
ErrorsNULL_ARGUMENTsubscriptionEnablerIds is null
CompliancemandatoryThis method must be implemented.
MethodorderSubscriptionEnablerResults
Description

Specify an ordering to the search results.

Parametersosid.subscription.rules.SubscriptionEnablerSearchOrdersubscriptionEnablerSearchOrdersubscription enabler search order
ErrorsNULL_ARGUMENTsubscriptionEnablerSearchOrder is null
UNSUPPORTEDsubscriptionEnablerSearchOrder 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_ARGUMENTsubscriptionEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(subscriptionEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.