org.osid.provisioning.rules

Interface QueueProcessorSearchSession

All Superinterfaces:

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

public interface QueueProcessorSearchSession
extends QueueProcessorQuerySession

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

getQueueProcessorsByQuery() is the basic search method and returns a list of QueueProcessors. A more advanced search may be performed with getQueueProcessorsBySearch(). It accepts a QueueProcessorSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as provisioning. getQueueProcessorsBySearch() returns a QueueProcessorSearchResults that can be used to access the resulting QueueProcessorList or be used to perform a search within the result set through QueueProcessorSearch.

This session defines views that offer differing behaviors for searching.

• federated distributor view: searches include queue processor in distributors of which this distributor is an ancestor in the distributor hierarchy
• isolated distributor view: searches are restricted to queue processor in this distributor

QueueProcessors may have a query record indicated by their respective record types. Thequery record is accessed via the QueueProcessorQuery.

Method Summary

Methods

Modifier and Type	Method and Description
QueueProcessorQuery	getQueueProcessorQueryFromInspector(QueueProcessorQueryInspector queueProcessorQueryInspector) Gets a queue processor query from an inspector.
QueueProcessorSearchResults	getQueueProcessorsBySearch(QueueProcessorQuery queueProcessorQuery, QueueProcessorSearch queueProcessorSearch) Gets the search results matching the given search query using the given search.
QueueProcessorSearch	getQueueProcessorSearch() Gets a queue processor search.
QueueProcessorSearchOrder	getQueueProcessorSearchOrder() Gets a queue processor search order.

Methods inherited from interface org.osid.provisioning.rules.QueueProcessorQuerySession

canSearchQueueProcessors, getDistributor, getDistributorId, getQueueProcessorQuery, getQueueProcessorsByQuery, 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

getQueueProcessorSearch

QueueProcessorSearch getQueueProcessorSearch()

Gets a queue processor search.

Returns:

the queue processor search

Compliance:

mandatory - This method must be implemented.

getQueueProcessorSearchOrder

QueueProcessorSearchOrder getQueueProcessorSearchOrder()

Gets a queue processor search order. The QueueProcessorSearchOrder is supplied to a QueueProcessorSearch to specify the ordering of results.

Returns:

the queue processor search order

Compliance:

mandatory - This method must be implemented.

getQueueProcessorsBySearch

QueueProcessorSearchResults getQueueProcessorsBySearch(QueueProcessorQuery queueProcessorQuery,
                                                     QueueProcessorSearch queueProcessorSearch)
                                                       throws OperationFailedException,
                                                              PermissionDeniedException

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

Parameters:

queueProcessorQuery - the queue processor query

queueProcessorSearch - the queue processor search

Returns:

the returned search results

Throws:

NullArgumentException - queueProcessorQuery or queueProcessorSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - queueProcessorQuery or queueProcessorSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getQueueProcessorQueryFromInspector

QueueProcessorQuery getQueueProcessorQueryFromInspector(QueueProcessorQueryInspector queueProcessorQueryInspector)

Gets a queue processor query from an inspector. The inspector is available from a QueueProcessorSearchResults.

Parameters:

queueProcessorQueryInspector - a queue processor query inspector

Returns:

the queue processor query

Throws:

NullArgumentException - queueProcessorQueryInspector is null

UnsupportedException - queueProcessorQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.