public interface QueueProcessorQuerySession extends OsidSession
This session provides methods for searching among QueueProcessor
objects. The search query is constructed using the
QueueProcessorQuery.
This session defines views that offer differing behaviors for searching.
Queue processor may have a query record indicated by their respective
record types. The query record is accessed via the
QueueProcessorQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchQueueProcessors()
Tests if this user can perform
QueueProcessor lookups. |
FrontOffice |
getFrontOffice()
Gets the
FrontOffice associated with this session. |
Id |
getFrontOfficeId()
Gets the
FrontOffice Id associated with
this session. |
QueueProcessorQuery |
getQueueProcessorQuery()
Gets a queue processor query.
|
QueueProcessorList |
getQueueProcessorsByQuery(QueueProcessorQuery queueProcessorQuery)
Gets a list of
QueueProcessors matching the given queue
processor query. |
void |
useFederatedFrontOfficeView()
Federates the view for methods in this session.
|
void |
useIsolatedFrontOfficeView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getFrontOfficeId()
FrontOffice
Id
associated with
this session. FrontOffice Id
associated with this sessionmandatory
- This method must be implemented. FrontOffice getFrontOffice() throws OperationFailedException, PermissionDeniedException
FrontOffice
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchQueueProcessors()
QueueProcessor
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. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedFrontOfficeView()
mandatory
- This method is must be implemented. void useIsolatedFrontOfficeView()
mandatory
- This method is must be implemented. QueueProcessorQuery getQueueProcessorQuery()
mandatory
- This method must be implemented. QueueProcessorList getQueueProcessorsByQuery(QueueProcessorQuery queueProcessorQuery) throws OperationFailedException, PermissionDeniedException
QueueProcessors
matching the given queue
processor query.queueProcessorQuery
- the queue processor query QueueProcessorList
NullArgumentException
- queueProcessorQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- queueProcessorQuery
is not of this servicemandatory
- This method must be implemented.