org.osid.subscription

Interface SubscriptionSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession, SubscriptionQuerySession

public interface SubscriptionSearchSession
extends SubscriptionQuerySession

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.

Method Summary

Methods

Modifier and Type	Method and Description
SubscriptionQuery	getSubscriptionQueryFromInspector(SubscriptionQueryInspector subscriptionQueryInspector) Gets an entry query from an inspector.
SubscriptionSearchResults	getSubscriptionsBySearch(SubscriptionQuery subscriptionQuery, SubscriptionSearch subscriptionSearch) Gets the subscription search results matching the given search.
SubscriptionSearch	getSubscriptionSearch() Gets a subscription search.
SubscriptionSearchOrder	getSubscriptionSearchOrder() Gets a subscription search order.

Methods inherited from interface org.osid.subscription.SubscriptionQuerySession

canSearchSubscriptions, getPublisher, getPublisherId, getSubscriptionQuery, getSubscriptionsByQuery, useFederatedPublisherView, useIsolatedPublisherView

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getSubscriptionSearch

SubscriptionSearch getSubscriptionSearch()

Gets a subscription search.

Returns:

the subscription search

Compliance:

mandatory - This method must be implemented.

getSubscriptionSearchOrder

SubscriptionSearchOrder getSubscriptionSearchOrder()

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

Returns:

the subscription search order

Compliance:

mandatory - This method must be implemented.

getSubscriptionsBySearch

SubscriptionSearchResults getSubscriptionsBySearch(SubscriptionQuery subscriptionQuery,
                                                 SubscriptionSearch subscriptionSearch)
                                                   throws OperationFailedException,
                                                          PermissionDeniedException

Gets the subscription search results matching the given search.

Parameters:

subscriptionQuery - the subscription query

subscriptionSearch - the subscription search

Returns:

the subscription search results

Throws:

NullArgumentException - subscriptionQuery or subscriptionSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - subscriptionQuery or subscriptionSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getSubscriptionQueryFromInspector

SubscriptionQuery getSubscriptionQueryFromInspector(SubscriptionQueryInspector subscriptionQueryInspector)

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

Parameters:

subscriptionQueryInspector - a query inspector

Returns:

the entry query

Throws:

NullArgumentException - subscriptionQueryInspector is null

UnsupportedException - subscriptionQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.