public interface QueueConstrainerFrontOfficeSession extends OsidSession
This session provides methods to retrieve QueueConstrainer
to FrontOffice
mappings. a QueueConstrainer
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 |
canLookupQueueConstrainerFrontOfficeMappings()
Tests if this user can perform lookups of queue constrainer/office
mappings.
|
IdList |
getFrontOfficeIdsByQueueConstrainer(Id queueConstrainerId)
Gets the
FrontOffice Ids mapped to a
QueueConstrainer. |
FrontOfficeList |
getFrontOfficesByQueueConstrainer(Id queueConstrainerId)
Gets the
FrontOffices mapped to a
QueueConstrainer. |
IdList |
getQueueConstrainerIdsByFrontOffice(Id frontOfficeId)
Gets the list of
QueueConstrainerIds associated with an
FrontFront Office. |
IdList |
getQueueConstrainerIdsByFrontOffices(IdList frontOfficeIds)
Gets the list of
QueueConstrainer Ids corresponding to
a list of FrontOffices. |
QueueConstrainerList |
getQueueConstrainersByFrontOffice(Id frontOfficeId)
Gets the list of queue constrainer associated with an
FrontFront Office. |
QueueConstrainerList |
getQueueConstrainersByFrontOffices(IdList frontOfficeIds)
Gets the list of queue constrainer corresponding to a list of
FrontOffices. |
void |
useComparativeQueueConstrainerFrontOfficeView()
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 |
usePlenaryQueueConstrainerFrontOfficeView()
A complete view of the
QueueConstrainer and
FrontOffice returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupQueueConstrainerFrontOfficeMappings()
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 useComparativeQueueConstrainerFrontOfficeView()
mandatory
- This method is must be implemented. void usePlenaryQueueConstrainerFrontOfficeView()
QueueConstrainer
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 getQueueConstrainerIdsByFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
QueueConstrainerIds
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. QueueConstrainerList getQueueConstrainersByFrontOffice(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 getQueueConstrainerIdsByFrontOffices(IdList frontOfficeIds) throws OperationFailedException, PermissionDeniedException
QueueConstrainer 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. QueueConstrainerList getQueueConstrainersByFrontOffices(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 getFrontOfficeIdsByQueueConstrainer(Id queueConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
FrontOffice
Ids
mapped to a
QueueConstrainer.
queueConstrainerId
- Id
of a
QueueConstrainer
NotFoundException
- queueConstrainerId
is not foundNullArgumentException
- queueConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. FrontOfficeList getFrontOfficesByQueueConstrainer(Id queueConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
FrontOffices
mapped to a
QueueConstrainer.
queueConstrainerId
- Id
of a
QueueConstrainer
NotFoundException
- queueConstrainerId
is not foundNullArgumentException
- queueConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.