org.osid.provisioning.rules

Interface QueueConstrainerEnablerSearchSession

All Superinterfaces:

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

public interface QueueConstrainerEnablerSearchSession
extends QueueConstrainerEnablerQuerySession

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

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

This session defines views that offer differing behaviors for searching.

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

QueueConstrainerEnablers may have a query record indicated by their respective record types. The query record is accessed via the QueueConstrainerEnablerQuery.

Method Summary

Methods

Modifier and Type	Method and Description
QueueConstrainerEnablerQuery	getQueueConstrainerEnablerQueryFromInspector(QueueConstrainerEnablerQueryInspector queueConstrainerEnablerQueryInspector) Gets a queue constrainer enabler query from an inspector.
QueueConstrainerEnablerSearchResults	getQueueConstrainerEnablersBySearch(QueueConstrainerEnablerQuery queueConstrainerEnablerQuery, QueueConstrainerEnablerSearch queueConstrainerEnablerSearch) Gets the search results matching the given search query using the given search.
QueueConstrainerEnablerSearch	getQueueConstrainerEnablerSearch() Gets a queue constrainer enabler search.
QueueConstrainerEnablerSearchOrder	getQueueConstrainerEnablerSearchOrder() Gets a queue constrainer enabler search order.

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

canSearchQueueConstrainerEnablers, getDistributor, getDistributorId, getQueueConstrainerEnablerQuery, getQueueConstrainerEnablersByQuery, 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

getQueueConstrainerEnablerSearch

QueueConstrainerEnablerSearch getQueueConstrainerEnablerSearch()

Gets a queue constrainer enabler search.

Returns:

the queue constrainer enabler search

Compliance:

mandatory - This method must be implemented.

getQueueConstrainerEnablerSearchOrder

QueueConstrainerEnablerSearchOrder getQueueConstrainerEnablerSearchOrder()

Gets a queue constrainer enabler search order. The QueueConstrainerEnablerSearchOrder is supplied to a QueueConstrainerEnablerSearch to specify the ordering of results.

Returns:

the queue constrainer enabler search order

Compliance:

mandatory - This method must be implemented.

getQueueConstrainerEnablersBySearch

QueueConstrainerEnablerSearchResults getQueueConstrainerEnablersBySearch(QueueConstrainerEnablerQuery queueConstrainerEnablerQuery,
                                                                       QueueConstrainerEnablerSearch queueConstrainerEnablerSearch)
                                                                         throws OperationFailedException,
                                                                                PermissionDeniedException

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

Parameters:

queueConstrainerEnablerQuery - the queue constrainer enabler query

queueConstrainerEnablerSearch - the queue constrainer enabler search

Returns:

the returned search results

Throws:

NullArgumentException - queueConstrainerEnablerQuery or queueConstrainerEnablerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - queueConstrainerEnablerQuery or queueConstrainerEnablerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getQueueConstrainerEnablerQueryFromInspector

QueueConstrainerEnablerQuery getQueueConstrainerEnablerQueryFromInspector(QueueConstrainerEnablerQueryInspector queueConstrainerEnablerQueryInspector)

Gets a queue constrainer enabler query from an inspector. The inspector is available from a QueueConstrainerEnablerSearchResults.

Parameters:

queueConstrainerEnablerQueryInspector - a queue constrainer enabler query inspector

Returns:

the queue constrainer enabler query

Throws:

NullArgumentException - queueConstrainerEnablerQueryInspector is null

UnsupportedException - queueConstrainerEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.