public interface QueueConstrainerEnablerFrontOfficeSession extends OsidSession
This session provides methods to retrieve
QueueConstrainerEnabler
to FrontOffice
mappings. a
QueueConstrainerEnabler
may appear in multiple
FrontOffice
objects. Each front office may have its own
authorizations governing who is allowed to look at it.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupQueueConstrainerEnablerFrontOfficeMappings()
Tests if this user can perform lookups of queue constrainer
enabler/office mappings.
|
IdList |
getFrontOfficeIdsByQueueConstrainerEnabler(Id queueConstrainerEnablerId)
Gets the
FrontOffice Ids mapped to a
QueueConstrainerEnabler. |
FrontOfficeList |
getFrontOfficesByQueueConstrainerEnabler(Id queueConstrainerEnablerId)
Gets the
FrontOffices mapped to a
QueueConstrainerEnabler. |
IdList |
getQueueConstrainerEnablerIdsByFrontOffice(Id frontOfficeId)
Gets the list of
QueueConstrainerEnablerIds associated
with an FrontFront Office. |
IdList |
getQueueConstrainerEnablerIdsByFrontOffices(IdList frontOfficeIds)
Gets the list of
QueueConstrainerEnabler Ids
corresponding to a list of FrontOffices. |
QueueConstrainerEnablerList |
getQueueConstrainerEnablersByFrontOffice(Id frontOfficeId)
Gets the list of queue constrainer enablers associated with an
FrontFront Office. |
QueueConstrainerEnablerList |
getQueueConstrainerEnablersByFrontOffices(IdList frontOfficeIds)
Gets the list of queue constrainer enablers corresponding to a list of
FrontOffices. |
void |
useComparativeQueueConstrainerEnablerFrontOfficeView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
usePlenaryQueueConstrainerEnablerFrontOfficeView()
A complete view of the
QueueConstrainerEnabler and
FrontOffice returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupQueueConstrainerEnablerFrontOfficeMappings()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer lookup operations to
unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeQueueConstrainerEnablerFrontOfficeView()
mandatory
- This method is must be implemented. void usePlenaryQueueConstrainerEnablerFrontOfficeView()
QueueConstrainerEnabler
and
FrontOffice
returns is desired. Methods will return
what is requested or result in an error. This view is used when
greater precision is desired at the expense of interoperability.mandatory
- This method is must be implemented. IdList getQueueConstrainerEnablerIdsByFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
QueueConstrainerEnablerIds
associated
with an FrontFront Office.
frontOfficeId
- Id
of the FrontOffice
Ids
NotFoundException
- frontOfficeId
is not
foundNullArgumentException
- frontOfficeId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. QueueConstrainerEnablerList getQueueConstrainerEnablersByFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
FrontFront Office.
frontOfficeId
- Id
of the FrontOffice
NotFoundException
- frontOfficeId
is not
foundNullArgumentException
- frontOfficeId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getQueueConstrainerEnablerIdsByFrontOffices(IdList frontOfficeIds) throws OperationFailedException, PermissionDeniedException
QueueConstrainerEnabler Ids
corresponding to a list of FrontOffices.
frontOfficeIds
- list of front office Ids
Ids
NullArgumentException
- frontOfficeIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. QueueConstrainerEnablerList getQueueConstrainerEnablersByFrontOffices(IdList frontOfficeIds) throws OperationFailedException, PermissionDeniedException
FrontOffices.
frontOfficeIds
- list of front office Ids
NullArgumentException
- frontOfficeIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getFrontOfficeIdsByQueueConstrainerEnabler(Id queueConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
FrontOffice
Ids
mapped to a
QueueConstrainerEnabler.
queueConstrainerEnablerId
- Id
of a
QueueConstrainerEnabler
NotFoundException
- queueConstrainerEnablerId
is not foundNullArgumentException
-
queueConstrainerEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. FrontOfficeList getFrontOfficesByQueueConstrainerEnabler(Id queueConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
FrontOffices
mapped to a
QueueConstrainerEnabler.
queueConstrainerEnablerId
- Id
of a
QueueConstrainerEnabler
NotFoundException
- queueConstrainerEnablerId
is not foundNullArgumentException
-
queueConstrainerEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.