org.osid.tracking.rules

Interface QueueConstrainerEnablerQuerySession

All Superinterfaces:

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

All Known Subinterfaces:

QueueConstrainerEnablerSearchSession

public interface QueueConstrainerEnablerQuerySession
extends OsidSession

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

This session defines views that offer differing behaviors for searching.

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

Queue constrainer enablers 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
boolean	canSearchQueueConstrainerEnablers() Tests if this user can perform QueueConstrainerEnabler lookups.
FrontOffice	getFrontOffice() Gets the FrontOffice associated with this session.
Id	getFrontOfficeId() Gets the FrontOffice Id associated with this session.
QueueConstrainerEnablerQuery	getQueueConstrainerEnablerQuery() Gets a queue constrainer enabler query.
QueueConstrainerEnablerList	getQueueConstrainerEnablersByQuery(QueueConstrainerEnablerQuery queueConstrainerEnablerQuery) Gets a list of QueueConstrainerEnablers matching the given queue constrainer enabler 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 office

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSearchQueueConstrainerEnablers

boolean canSearchQueueConstrainerEnablers()

Tests if this user can perform QueueConstrainerEnabler 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 queue constrainer enablers in front offices which are children of this queue 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 lookups to this front office only.

Compliance:

mandatory - This method is must be implemented.

getQueueConstrainerEnablerQuery

QueueConstrainerEnablerQuery getQueueConstrainerEnablerQuery()

Gets a queue constrainer enabler query.

Returns:

the queue constrainer enabler query

Compliance:

mandatory - This method must be implemented.

getQueueConstrainerEnablersByQuery

QueueConstrainerEnablerList getQueueConstrainerEnablersByQuery(QueueConstrainerEnablerQuery queueConstrainerEnablerQuery)
                                                               throws OperationFailedException,
                                                                      PermissionDeniedException

Gets a list of QueueConstrainerEnablers matching the given queue constrainer enabler query.

Parameters:

queueConstrainerEnablerQuery - the sequeue constrainer enabler query

Returns:

the returned QueueConstrainerEnablerList

Throws:

NullArgumentException - queueConstrainerEnablerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - queueConstrainerEnablerQuery is not of this service

Compliance:

mandatory - This method must be implemented.