OSID Logo
OSID Specifications
subscription rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.subscription.rules.SubscriptionEnablerSearchSession
Implementsosid.subscription.rules.SubscriptionEnablerQuerySession
Description

This session provides methods for searching among SubscriptionEnabler objects. The search query is constructed using the SubscriptionEnableryQuery.

getSubscriptionEnablersByQuery() is the basic search method and returns a list of SubscriptionEnablers. A more advanced search may be performed with getSubscriptionEnablersBySearch(). It accepts a SubscriptionEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getSubscriptionEnablersBySearch() returns a SubscriptionEnablerSearchResults that can be used to access the resulting SubscriptionEnablerList or be used to perform a search within the result set through SubscriptionEnablerSearch.

This session defines views that offer differing behaviors for searching.

  • federated subscription view: searches include subscription enablers in subscriptions of which this subscription is an ancestor in the subscription hierarchy
  • isolated subscription view: searches are restricted to subscription enablers in this subscription

SubscriptionEnablers may have a query record indicated by their respective record types. The query record is accessed via the SubscriptionEnablerQuery.

MethodgetSubscriptionEnablerSearch
Description

Gets a subscription enabler search.

Returnosid.subscription.rules.SubscriptionEnablerSearchthe subscription enabler search
CompliancemandatoryThis method must be implemented.
MethodgetSubscriptionEnablerSearchOrder
Description

Gets a subscription enabler search order. The SubscriptionEnablerSearchOrder is supplied to a SubscriptionEnablerSearch to specify the ordering of results.

Returnosid.subscription.rules.SubscriptionEnablerSearchOrderthe subscription enabler search order
CompliancemandatoryThis method must be implemented.
MethodgetSubscriptionEnablersBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.subscription.rules.SubscriptionEnablerQuerysubscriptionEnablerQuerythe subscription enabler query
osid.subscription.rules.SubscriptionEnablerSearchsubscriptionEnablerSearchthe subscription enabler search
Returnosid.subscription.rules.SubscriptionEnablerSearchResultsthe returned search results
ErrorsNULL_ARGUMENT subscriptionEnablerQuery or subscriptionEnablerSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED subscriptionEnablerQuery or subscriptionEnablerSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetSubscriptionEnablerQueryFromInspector
Description

Gets a subscription enabler query from an inspector. The inspector is available from a SubscriptionEnablerSearchResults.

Parametersosid.subscription.rules.SubscriptionEnablerQueryInspectorsubscriptionEnablerQueryInspectora subscription enabler query inspector
Returnosid.subscription.rules.SubscriptionEnablerQuerythe subscription enabler query
ErrorsNULL_ARGUMENT subscriptionEnablerQueryInspector is null
UNSUPPORTED subscriptionEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.