OSID Logo
OSID Specifications
subscription package
Version 3.0.0
Release Candidate Preview
Interfaceosid.subscription.SubscriptionSearchSession
Implementsosid.subscription.SubscriptionQuerySession
Description

This session provides methods for searching Subscription objects. The search query is constructed using the SubscriptionQuery. The subscription record Type also specifies the record for the subscription query.

getSubscriptionsByQuery() is the basic search method and returns a list of Publisher elements. A more advanced search may be performed with getSubscriptionsBySearch(). It accepts a SubscriptionSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getSubscriptionsBySearch() returns a SubscriptionSearchResults that can be used to access the resulting SubscriptionList or be used to perform a search within the result set through SubscriptionSearch.

Subscriptions may have a query record indicated by their respective record types. The query record is accessed via the SubscriptionQuery. The returns in this session may not be cast directly to these interfaces.

MethodgetSubscriptionSearch
Description

Gets a subscription search.

Returnosid.subscription.SubscriptionSearchthe subscription search
CompliancemandatoryThis method must be implemented.
MethodgetSubscriptionSearchOrder
Description

Gets a subscription search order. The SubscriptionSearchOrder is supplied to a SubscriptionSearch to specify the ordering of results.

Returnosid.subscription.SubscriptionSearchOrderthe subscription search order
CompliancemandatoryThis method must be implemented.
MethodgetSubscriptionsBySearch
Description

Gets the subscription search results matching the given search.

Parametersosid.subscription.SubscriptionQuerysubscriptionQuerythe subscription query
osid.subscription.SubscriptionSearchsubscriptionSearchthe subscription search
Returnosid.subscription.SubscriptionSearchResultsthe subscription search results
ErrorsNULL_ARGUMENT subscriptionQuery or subscriptionSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED subscriptionQuery or subscriptionSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetSubscriptionQueryFromInspector
Description

Gets an entry query from an inspector. The inspector is available from an SubscriptionSearchResults.

Parametersosid.subscription.SubscriptionQueryInspectorsubscriptionQueryInspectora query inspector
Returnosid.subscription.SubscriptionQuerythe entry query
ErrorsNULL_ARGUMENT subscriptionQueryInspector is null
UNSUPPORTED subscriptionQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.