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

The search interface for governing subscription searches.

MethodsearchAmongSubscriptions
Description

Execute this search among the given list of subscriptions.

Parametersosid.id.IdListsubscriptionIdslist of subscriptions
ErrorsNULL_ARGUMENT subscriptionIds is null
CompliancemandatoryThis method must be implemented.
MethodorderSubscriptionResults
Description

Specify an ordering to the search results.

Parametersosid.subscription.SubscriptionSearchOrdersubscriptionSearchOrdersubscription search order
ErrorsNULL_ARGUMENT subscriptionSearchOrder is null
UNSUPPORTED subscriptionSearchOrder is not of this service
CompliancemandatoryThis 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.TypesubscriptionSearchRecordTypea subscription search record type
Returnosid.subscription.records.SubscriptionSearchRecordthe subscription search record
ErrorsNULL_ARGUMENT subscriptionSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(subscriptionSearchRecordType) is false
CompliancemandatoryThis method must be implemented.