OSID Logo
OSID Specifications
subscription package
Version 3.1.0
Interfaceosid.subscription.SubscriptionSearch
Implementsosid.OsidSearch
Used Byosid.subscription.SubscriptionSearchSession
Description

The search interface for governing subscription searches.

MethodsearchAmongSubscriptions
Description

Execute this search among the given list of subscriptions.

Parametersosid.id.IdListsubscriptionIds list of subscriptions
ErrorsNULL_ARGUMENT subscriptionIds is null
Compliancemandatory This method must be implemented.
MethodorderSubscriptionResults
Description

Specify an ordering to the search results.

Parametersosid.subscription.SubscriptionSearchOrdersubscriptionSearchOrder subscription search order
ErrorsNULL_ARGUMENT subscriptionSearchOrder is null
UNSUPPORTED subscriptionSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetSubscriptionSearchRecord
Description

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

Parametersosid.type.TypesubscriptionSearchRecordType a subscription search record type
Returnosid.subscription.records.SubscriptionSearchRecord the subscription search record
ErrorsNULL_ARGUMENT subscriptionSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(subscriptionSearchRecordType) is false
Compliancemandatory This method must be implemented.