public interface QueueProcessorRuleApplicationSession extends OsidSession
This session provides methods to apply QueueProcessors
to Queues.
Modifier and Type | Method and Description |
---|---|
void |
assignQueueProcessorToQueue(Id queueProcessorId,
Id queueId)
Adds an existing
QueueProcessor to a Queue. |
boolean |
canAssignQueueProcessors()
Tests if this user can alter queue processor/queue mappings.
|
boolean |
canSequenceQueueProcessors()
Tests if this user can order
QueueProcessors. |
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
void |
moveQueueProcessorAhead(Id queueProcessorId,
Id queueId,
Id referenceId)
Reorders queue processors for a queue by moving the specified queue
processor in front of a reference queue processor.
|
void |
moveQueueProcessorBehind(Id queueProcessorId,
Id queueId,
Id referenceId)
Reorders queue processors for a queue by moving the specified queue
processor behind a reference queue processor.
|
void |
orderQueueProcessors(Id[] queueProcessorIds,
Id queueId)
Reorders a set of queue processors for a queue.
|
void |
unassignQueueProcessorFromQueue(Id queueProcessorId,
Id queueId)
Removes a
QueueProcessor from a Queue. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getDistributorId()
Distributor
Id
associated with
this session. Distributor Id
associated with this sessionmandatory
- This method must be implemented. Distributor getDistributor() throws OperationFailedException, PermissionDeniedException
Distributor
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canAssignQueueProcessors()
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer lookup operations to
unauthorized users. false
if mapping is not authorized, true
otherwisemandatory
- This method must be implemented. void assignQueueProcessorToQueue(Id queueProcessorId, Id queueId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
QueueProcessor
to a Queue.
queueProcessorId
- the Id
of the
QueueProcessor
queueId
- the Id
of the Queue
AlreadyExistsException
- queueProcessorId
is already applied to queueId
NotFoundException
- queueProcessorId
or
queueId
not foundNullArgumentException
- queueProcessorId
or queueId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignQueueProcessorFromQueue(Id queueProcessorId, Id queueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
QueueProcessor
from a Queue.
queueProcessorId
- the Id
of the
QueueProcessor
queueId
- the Id
of the Queue
NotFoundException
- queueProcessorId
or
queueId
not found or queueProcessorId
not applied to queueId
NullArgumentException
- queueProcessorId
or queueId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSequenceQueueProcessors()
QueueProcessors.
A return
of true does not guarantee successful authorization. A return of false
indicates that it is known sequencing operations will result in a
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer sequencing operations to an
unauthorized user. false
if QueueProcessor
ordering
is not authorized, true
otherwisemandatory
- This method must be implemented. void moveQueueProcessorAhead(Id queueProcessorId, Id queueId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
queueProcessorId
- the Id
of a
QueueProcessor
queueId
- the Id
of a Queue
referenceId
- the reference queue processor Id
NotFoundException
- queueProcessorId, queueId,
or referenceId
not found or,
queueProcessorId
or referenceId
not
related to queueId
NullArgumentException
- queueProcessorId,
queueId,
or referenceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void moveQueueProcessorBehind(Id queueProcessorId, Id queueId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
queueProcessorId
- the Id
of a
QueueProcessor
queueId
- the Id
of a Queue
referenceId
- the reference queue processor Id
NotFoundException
- queueProcessorId, queueId,
or referenceId
not found or,
queueProcessorId
or referenceId
not
related to queueId
NullArgumentException
- queueProcessorId,
queueId,
or referenceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void orderQueueProcessors(Id[] queueProcessorIds, Id queueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
queueProcessorIds
- the Ids
for a set of
QueueProcessors
queueId
- the Id
of a QueueProcessor
NotFoundException
- queueId
not found
or, a queueProcessorId
not related to
queueId
NullArgumentException
- queueProcessorIds
or queueId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.