public interface QueueConstrainerEnablerRuleApplicationSession extends OsidSession
This session provides methods to apply QueueConstrainerEnablers
to QueueConstrainers.
a QueueConstrainer
with multiple QueueConstrainerEnablers
means any
positive rule evaluation across the enablers result in an effective
QueueConstrainer.
Modifier and Type | Method and Description |
---|---|
void |
assignQueueConstrainerEnablerToQueueConstrainer(Id queueConstrainerEnablerId,
Id queueConstrainerId)
Adds an existing
QueueConstrainerEnabler to a
QueueConstrainer. |
boolean |
canAssignQueueConstrainerEnablers()
Tests if this user can alter queue constrainer enabler/queue
constrainer mappings.
|
boolean |
canSequenceQueueConstrainerEnablers()
Tests if this user can order
QueueConstrainerEnablers. |
FrontOffice |
getFrontOffice()
Gets the
FrontOffice associated with this session. |
Id |
getFrontOfficeId()
Gets the
FrontOffice Id associated with
this session. |
void |
moveQueueConstrainerEnablerAhead(Id queueConstrainerEnablerId,
Id queueConstrainerId,
Id referenceId)
Reorders queue constrainer enablers for a queue constrainer by moving
the specified queue constrainer enabler in front of a reference queue
constrainer enabler.
|
void |
moveQueueConstrainerEnablerBehind(Id queueConstrainerEnablerId,
Id queueConstrainerId,
Id referenceId)
Reorders queue constrainer enablers for a queue constrainer by moving
the specified queue constrainer enabler behind a reference queue
constrainer enabler.
|
void |
orderQueueConstrainerEnablers(Id[] queueConstrainerEnablerIds,
Id queueConstrainerId)
Reorders a set of queue constrainer enablers for a queue constrainer.
|
void |
unassignQueueConstrainerEnablerFromQueueConstrainer(Id queueConstrainerEnablerId,
Id queueConstrainerId)
Removes a
QueueConstrainerEnabler from a
QueueConstrainer. |
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 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. void assignQueueConstrainerEnablerToQueueConstrainer(Id queueConstrainerEnablerId, Id queueConstrainerId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
QueueConstrainerEnabler
to a
QueueConstrainer.
queueConstrainerEnablerId
- the Id
of the
QueueConstrainerEnabler
queueConstrainerId
- the Id
of the
QueueConstrainer
AlreadyExistsException
-
queueConstrainerEnablerId
is already applied to
queueConstrainerId
NotFoundException
- queueConstrainerEnablerId
or queueConstrainerId
not foundNullArgumentException
-
queueConstrainerEnablerId
or queueConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignQueueConstrainerEnablerFromQueueConstrainer(Id queueConstrainerEnablerId, Id queueConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
QueueConstrainerEnabler
from a
QueueConstrainer.
queueConstrainerEnablerId
- the Id
of the
QueueConstrainerEnabler
queueConstrainerId
- the Id
of the
QueueConstrainer
NotFoundException
- queueConstrainerEnablerId
or queueConstrainerId
not found or
queueConstrainerEnablerId
not applied to
queueConstrainerId
NullArgumentException
-
queueConstrainerEnablerId
or queueConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSequenceQueueConstrainerEnablers()
QueueConstrainerEnablers.
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 QueueConstrainerEnabler
ordering is not authorized, true
otherwisemandatory
- This method must be implemented. void moveQueueConstrainerEnablerAhead(Id queueConstrainerEnablerId, Id queueConstrainerId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
queueConstrainerEnablerId
- the Id
of a
QueueConstrainerEnabler
queueConstrainerId
- the Id
of a
QueueConstrainer
referenceId
- the reference queue constrainer enabler Id
NotFoundException
- queueConstrainerEnablerId,
queueConstrainerId,
or referenceId
not
found or, queueConstrainerEnablerId
or
referenceId
not related to queueConstrainerId
NullArgumentException
-
queueConstrainerEnablerId, queueConstrainerId,
or
referenceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void moveQueueConstrainerEnablerBehind(Id queueConstrainerEnablerId, Id queueConstrainerId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
queueConstrainerEnablerId
- the Id
of a
QueueConstrainerEnabler
queueConstrainerId
- the Id
of a
QueueConstrainer
referenceId
- the reference queue constrainer enabler Id
NotFoundException
- queueConstrainerEnablerId,
queueConstrainerId,
or referenceId
not
found or, queueConstrainerEnablerId
or
referenceId
not related to queueConstrainerId
NullArgumentException
-
queueConstrainerEnablerId, queueConstrainerId,
or
referenceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void orderQueueConstrainerEnablers(Id[] queueConstrainerEnablerIds, Id queueConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
queueConstrainerEnablerIds
- the Ids
for a set of
QueueConstrainerEnablers
queueConstrainerId
- the Id
of a
QueueConstrainer
NotFoundException
- queueConstrainerId
not found or, an queueConstrainerEnablerId
not
related to queueConstrainerId
NullArgumentException
-
queueConstrainerEnablerIds
or
queueConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.