OSID Logo
OSID Specifications
subscription rules package
Version 3.0.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.SubscriptionEnablerListthe subscription enabler list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetSubscriptionEnablerQueryInspector
Description

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

Returnosid.subscription.rules.SubscriptionEnablerQueryInspectorthe subscription enabler query inspector
CompliancemandatoryThis 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.TypesubscriptionEnablerSearchRecordTypea subscription enabler search record type
Returnosid.subscription.rules.records.SubscriptionEnablerSearchResultsRecordthe subscription enabler search results record
ErrorsNULL_ARGUMENTsubscriptionEnablerSearchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTEDhasRecordType(subscriptionEnablerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.