org.osid.tracking

Interface QueueQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

QueueSearchSession

public interface QueueQuerySession
extends OsidSession

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

This session defines views that offer differing behaviors for searching.

• federated front office view: searches include queues in front offices of which this front office is an ancestor in the front office hierarchy
• isolated front office view: searches are restricted to queues in this frontOffice

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canSearchQueues() Tests if this user can perform Queue lookups.
FrontOffice	getFrontOffice() Gets the FrontOffice associated with this session.
Id	getFrontOfficeId() Gets the FrontOffice 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	useFederatedFrontOfficeView() Federates the view for methods in this session.
void	useIsolatedFrontOfficeView() Isolates the view for methods in this session.

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

getFrontOfficeId

Id getFrontOfficeId()

Gets the FrontOffice Id associated with this session.

Returns:

the FrontOffice Id associated with this session

Compliance:

mandatory - This method must be implemented.

getFrontOffice

FrontOffice getFrontOffice()
                           throws OperationFailedException,
                                  PermissionDeniedException

Gets the FrontOffice associated with this session.

Returns:

the front office

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSearchQueues

boolean canSearchQueues()

Tests if this user can perform Queue lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedFrontOfficeView

void useFederatedFrontOfficeView()

Federates the view for methods in this session. A federated view will include queues in front offices which are children of this front office in the front office hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedFrontOfficeView

void useIsolatedFrontOfficeView()

Isolates the view for methods in this session. An isolated view restricts searches to this front office only.

Compliance:

mandatory - This method is must be implemented.

getQueueQuery

QueueQuery getQueueQuery()

Gets a queue query.

Returns:

the queue query

Compliance:

mandatory - This method must be implemented.

getQueuesByQuery

QueueList getQueuesByQuery(QueueQuery queueQuery)
                           throws OperationFailedException,
                                  PermissionDeniedException

Gets a list of Queues matching the given queue query.

Parameters:

queueQuery - the queue query

Returns:

the returned QueueList

Throws:

NullArgumentException - queueQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - queueQuery is not of this service

Compliance:

mandatory - This method must be implemented.