org.osid.provisioning

Interface QueueSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, 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

Methods

Modifier and Type	Method and 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 org.osid.provisioning.QueueQuerySession

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

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

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.