public interface QueueConstrainerFrontOfficeAssignmentSession extends OsidSession
This session provides methods to re-assign QueueConstrainer
to FrontOffice
mappings. a QueueConstrainer
may appear in multiple FrontOffice
objects and
removing the last reference to a QueueConstrainer
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 QueueConstrainer
to another
FrontOffice
is not a copy operation (eg: does not change
its Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignQueueConstrainerToFrontOffice(Id queueConstrainerId,
Id frontOfficeId)
Adds an existing
QueueConstrainer to an
FrontFront Office. |
boolean |
canAssignQueueConstrainers()
Tests if this user can alter queue constrainer/office mappings.
|
boolean |
canAssignQueueConstrainersToFrontOffice(Id frontOfficeId)
Tests if this user can alter queue constrainer/office mappings.
|
IdList |
getAssignableFrontOfficeIds(Id frontOfficeId)
Gets a list of front office including and under the given front office
node in which any queue constrainer can be assigned.
|
IdList |
getAssignableFrontOfficeIdsForQueueConstrainer(Id frontOfficeId,
Id queueConstrainerId)
Gets a list of front office including and under the given front office
node in which a specific queue constrainer can be assigned.
|
void |
unassignQueueConstrainerFromFrontOffice(Id queueConstrainerId,
Id frontOfficeId)
Removes a
QueueConstrainer from an FrontFront
Office. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignQueueConstrainers()
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 canAssignQueueConstrainersToFrontOffice(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 getAssignableFrontOfficeIdsForQueueConstrainer(Id frontOfficeId, Id queueConstrainerId) throws OperationFailedException
frontOfficeId
- the Id
of the FrontOffice
queueConstrainerId
- the Id
of the
QueueConstrainer
Ids
NullArgumentException
- frontOfficeId
or
queueConstrainerId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignQueueConstrainerToFrontOffice(Id queueConstrainerId, Id frontOfficeId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
QueueConstrainer
to an
FrontFront Office.
queueConstrainerId
- the Id
of the
QueueConstrainer
frontOfficeId
- the Id
of the FrontOffice
AlreadyExistsException
- queueConstrainerId
is already assigned to frontOfficeId
NotFoundException
- queueConstrainerId
or frontOfficeId
not foundNullArgumentException
- queueConstrainerId
or frontOfficeId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignQueueConstrainerFromFrontOffice(Id queueConstrainerId, Id frontOfficeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
QueueConstrainer
from an FrontFront
Office.
queueConstrainerId
- the Id
of the
QueueConstrainer
frontOfficeId
- the Id
of the FrontOffice
NotFoundException
- queueConstrainerId
or frontOfficeId
not found or
queueConstrainerId
not assigned to
frontOfficeId
NullArgumentException
- queueConstrainerId
or frontOfficeId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.