OSID Logo
OSID Specifications
subscription rules package
Version 3.1.0
Interfaceosid.subscription.rules.SubscriptionEnablerSearchResults
Implementsosid.OsidSearchResults
Used Byosid.subscription.rules.SubscriptionEnablerSearchSession
Description

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

MethodgetSubscriptionEnablers
Description

Gets the SubscriptionEnablerList resulting from a search.

Returnosid.subscription.rules.SubscriptionEnablerList the subscription enabler list
ErrorsILLEGAL_STATE list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetSubscriptionEnablerQueryInspector
Description

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

Returnosid.subscription.rules.SubscriptionEnablerQueryInspector the subscription enabler query inspector
Compliancemandatory This method must be implemented.
MethodgetSubscriptionEnablerSearchResultsRecord
Description

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

Parametersosid.type.TypesubscriptionEnablerSearchRecordType a subscription enabler search record type
Returnosid.subscription.rules.records.SubscriptionEnablerSearchResultsRecord the subscription enabler search results record
ErrorsNULL_ARGUMENT subscriptionEnablerSearchRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(subscriptionEnablerSearchRecordType) is false
Compliancemandatory This method must be implemented.