Interface SubscriptionSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, SubscriptionQuerySession

public interface SubscriptionSearchSession
extends SubscriptionQuerySession

This session provides methods for searching Subscriptions. 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Methods inherited from interface SubscriptionQuerySession

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

Modifier and Type	Method	Description
boolean	canSearchSubscriptions()	Tests if this user can perform susbcription searches.
Publisher	getPublisher()	Gets the Publisher associated with this session.
Id	getPublisherId()	Gets the Publisher Id associated with this session.
SubscriptionQuery	getSubscriptionQuery()	Gets a subscription query.
SubscriptionList	getSubscriptionsByQuery(SubscriptionQuery subscriptionQuery)	Gets a list of subscriptions matching the given subscription query.
void	useFederatedPublisherView()	Federates the view for methods in this session.
void	useIsolatedPublisherView()	Isolates the view for methods in this session.

Method Details

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.