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