Interface QueueEnablerSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, QueueEnablerQuerySession

public interface QueueEnablerSearchSession
extends QueueEnablerQuerySession

This session provides methods for searching among QueueEnablers . The search query is constructed using the QueueEnablerQuery .

getQueueEnablersByQuery() is the basic search method and returns a list of QueueEnablers . A more advanced search may be performed with getQueueEnablersBySearch() .It accepts a QueueEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getQueueEnablersBySearch() returns a QueueEnablerSearchResults that can be used to access the resulting QueueEnablerList or be used to perform a search within the result set through Que ueEnablerSearch .

This session defines views that offer differing behaviors for searching.

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

Queue enablers may have a query record indicated by their respective record types. The query record is accessed via the QueueEnablerQuery .

Method Summary

Modifier and Type	Method	Description
QueueEnablerQuery	getQueueEnablerQueryFromInspector(QueueEnablerQueryInspector queueEnablerQueryInspector)	Gets a queue enabler query from an inspector.
QueueEnablerSearchResults	getQueueEnablersBySearch(QueueEnablerQuery queueEnablerQuery, QueueEnablerSearch queueEnablerSearch)	Gets the search results matching the given search query using the given search.
QueueEnablerSearch	getQueueEnablerSearch()	Gets a queue enabler search.
QueueEnablerSearchOrder	getQueueEnablerSearchOrder()	Gets a queue enabler 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 QueueEnablerQuerySession

canSearchQueueEnablers, getDistributor, getDistributorId, getQueueEnablerQuery, getQueueEnablersByQuery, useFederatedDistributorView, useIsolatedDistributorView

Modifier and Type	Method	Description
boolean	canSearchQueueEnablers()	Tests if this user can perform QueueEnabler searches.
Distributor	getDistributor()	Gets the Distributor associated with this session.
Id	getDistributorId()	Gets the Distributor Id associated with this session.
QueueEnablerQuery	getQueueEnablerQuery()	Gets a queue enabler query.
QueueEnablerList	getQueueEnablersByQuery(QueueEnablerQuery queueEnablerQuery)	Gets a list of QueueEnablers matching the given search.
void	useFederatedDistributorView()	Federates the view for methods in this session.
void	useIsolatedDistributorView()	Isolates the view for methods in this session.

Method Details

getQueueEnablerSearch

QueueEnablerSearch getQueueEnablerSearch()

Gets a queue enabler search.

Returns:

the queue enabler search

Compliance:

mandatory - This method must be implemented.

getQueueEnablerSearchOrder

QueueEnablerSearchOrder getQueueEnablerSearchOrder()

Gets a queue enabler search order. The QueueEnablerSearchOrder is supplied to a QueueEnablerSearch to specify the ordering of results.

Returns:

the queue enabler search order

Compliance:

mandatory - This method must be implemented.

getQueueEnablersBySearch

QueueEnablerSearchResults getQueueEnablersBySearch(QueueEnablerQuery queueEnablerQuery,
 QueueEnablerSearch queueEnablerSearch)
                                            throws OperationFailedException,
PermissionDeniedException

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

Parameters:

queueEnablerQuery - the queue enabler query

queueEnablerSearch - the queue enabler search

Returns:

the returned search results

Throws:

NullArgumentException - queueEnablerQuery or queueEnablerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - queueEnablerQuery or queueEnablerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getQueueEnablerQueryFromInspector

QueueEnablerQuery getQueueEnablerQueryFromInspector(QueueEnablerQueryInspector queueEnablerQueryInspector)

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

Parameters:

queueEnablerQueryInspector - a queue enabler query inspector

Returns:

the queue enabler query

Throws:

NullArgumentException - queueEnablerQueryInspector is null

UnsupportedException - queueEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.