Interface QueueSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, QueueQuerySession

public interface QueueSearchSession
extends QueueQuerySession

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

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

This session defines views that offer differing behaviors for searching.

• federated broker view: searches include queues in brokers of which this broker is an ancestor in the broker hierarchy
• isolated broker view: searches are restricted to queues in this broker

Queues may have a queue record indicated by their respective record types. The queue record is accessed via the QueueQuery.

Method Summary

Modifier and Type	Method	Description
QueueQuery	getQueueQueryFromInspector(QueueQueryInspector queueQueryInspector)	Gets a queue query from an inspector.
QueueSearchResults	getQueuesBySearch(QueueQuery queueQuery, QueueSearch queueSearch)	Gets the search results matching the given search query using the given search.
QueueSearch	getQueueSearch()	Gets a queue search.
QueueSearchOrder	getQueueSearchOrder()	Gets a queue 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 QueueQuerySession

canSearchQueues, getDistributor, getDistributorId, getQueueQuery, getQueuesByQuery, useFederatedDistributorView, useIsolatedDistributorView

Modifier and Type	Method	Description
boolean	canSearchQueues()	Tests if this user can perform Queue lookups.
Distributor	getDistributor()	Gets the Distributor associated with this session.
Id	getDistributorId()	Gets the Distributor Id associated with this session.
QueueQuery	getQueueQuery()	Gets a queue query.
QueueList	getQueuesByQuery(QueueQuery queueQuery)	Gets a list of Queues matching the given queue query.
void	useFederatedDistributorView()	Federates the view for methods in this session.
void	useIsolatedDistributorView()	Isolates the view for methods in this session.

Method Details

getQueueSearch

QueueSearch getQueueSearch()

Gets a queue search.

Returns:

the queue search

Compliance:

mandatory - This method must be implemented.

getQueueSearchOrder

QueueSearchOrder getQueueSearchOrder()

Gets a queue search order. The QueueSearchOrder is supplied to a QueueSearch to specify the ordering of results.

Returns:

the queue search order

Compliance:

mandatory - This method must be implemented.

getQueuesBySearch

QueueSearchResults getQueuesBySearch(QueueQuery queueQuery,
 QueueSearch queueSearch)
                              throws OperationFailedException,
PermissionDeniedException

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

Parameters:

queueQuery - the queue query

queueSearch - the queue search

Returns:

the queue search results

Throws:

NullArgumentException - queueQuery or queueSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - queueQuery or queueSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getQueueQueryFromInspector

QueueQuery getQueueQueryFromInspector(QueueQueryInspector queueQueryInspector)

Gets a queue query from an inspector. The inspector is available from a QueueSearchResults.

Parameters:

queueQueryInspector - a queue query inspector

Returns:

the queue query

Throws:

NullArgumentException - queueQueryInspector is null

UnsupportedException - queueQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.