public interface QueueProcessorFrontOfficeAssignmentSession extends OsidSession
This session provides methods to re-assign QueueProcessor
to FrontOffice
mappings. a QueueProcessor
may appear in multiple FrontOffice
objects and
removing the last reference to a QueueProcessor
is the
equivalent of deleting it. Each FrontOffice
may have its
own authorizations governing who is allowed to operate on it.
Adding a reference of a QueueProcessor
to another
FrontOffice
is not a copy operation (eg: does not change
its Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignQueueProcessorToFrontOffice(Id queueProcessorId,
Id frontOfficeId)
Adds an existing
QueueProcessor to an FrontFront
Office. |
boolean |
canAssignQueueProcessors()
Tests if this user can alter queue processor/office mappings.
|
boolean |
canAssignQueueProcessorsToFrontOffice(Id frontOfficeId)
Tests if this user can alter queue processor/office mappings.
|
IdList |
getAssignableFrontOfficeIds(Id frontOfficeId)
Gets a list of front office including and under the given front office
node in which any queue processor can be assigned.
|
IdList |
getAssignableFrontOfficeIdsForQueueProcessor(Id frontOfficeId,
Id queueProcessorId)
Gets a list of front office including and under the given front office
node in which a specific queue processor can be assigned.
|
void |
unassignQueueProcessorFromFrontOffice(Id queueProcessorId,
Id frontOfficeId)
Removes a
QueueProcessor from an FrontFront
Office. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
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. boolean canAssignQueueProcessorsToFrontOffice(Id frontOfficeId)
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer lookup operations to
unauthorized users.frontOfficeId
- the Id
of the FrontOffice
false
if mapping is not authorized, true
otherwiseNullArgumentException
- frontOfficeId
is
null
mandatory
- This method must be implemented. IdList getAssignableFrontOfficeIds(Id frontOfficeId) throws OperationFailedException
frontOfficeId
- the Id
of the FrontOffice
Ids
NullArgumentException
- frontOfficeId
is
null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getAssignableFrontOfficeIdsForQueueProcessor(Id frontOfficeId, Id queueProcessorId) throws OperationFailedException
frontOfficeId
- the Id
of the FrontOffice
queueProcessorId
- the Id
of the
QueueProcessor
Ids
NullArgumentException
- frontOfficeId
or
queueProcessorId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignQueueProcessorToFrontOffice(Id queueProcessorId, Id frontOfficeId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
QueueProcessor
to an FrontFront
Office.
queueProcessorId
- the Id
of the
QueueProcessor
frontOfficeId
- the Id
of the FrontOffice
AlreadyExistsException
- queueProcessorId
is already assigned to frontOfficeId
NotFoundException
- queueProcessorId
or
frontOfficeId
not foundNullArgumentException
- queueProcessorId
or frontOfficeId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignQueueProcessorFromFrontOffice(Id queueProcessorId, Id frontOfficeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
QueueProcessor
from an FrontFront
Office.
queueProcessorId
- the Id
of the
QueueProcessor
frontOfficeId
- the Id
of the FrontOffice
NotFoundException
- queueProcessorId
or
frontOfficeId
not found or
queueProcessorId
not assigned to frontOfficeId
NullArgumentException
- queueProcessorId
or frontOfficeId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.