OSID Logo
OSID Specifications
subscription package
Version 3.1.0
Interfaceosid.subscription.SubscriptionSearchResults
Implementsosid.OsidSearchResults
Used Byosid.subscription.SubscriptionSearchSession
Description

This interface provides a means to capture results of a search.

MethodgetSubscriptions
Description

Gets the subscription list resulting from a search.

Returnosid.subscription.SubscriptionList the subscription list
ErrorsILLEGAL_STATE list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetSubscriptionQueryInspector
Description

Gets the inspector for the query to examine the terns used in the search.

Returnosid.subscription.SubscriptionQueryInspector the query inspector
Compliancemandatory This method must be implemented.
MethodgetSubscriptionSearchResultsRecord
Description

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

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