public interface QueueConstrainerLookupSession extends OsidSession
This session provides methods for retrieving QueueConstrainers.
This session defines views that offer differing behaviors when retrieving multiple objects.
QueueConstrainers
with the
QueueConstrainerAdminSession.
Generally, the comparative view should be used for most applications
as it permits operation even if there is data that cannot be accessed. The
methods useFederatedFrontOfficeView()
and
useIsolatedFrontOfficeView()
behave as a radio group and one
should be selected before invoking the methods in this session.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupQueueConstrainers()
Tests if this user can perform
QueueConstrainers
lookups. |
FrontOffice |
getFrontOffice()
Gets the
FrontOffice associated with this session. |
Id |
getFrontOfficeId()
Gets the
FrontOffice Id associated with
this session. |
QueueConstrainer |
getQueueConstrainer(Id queueConstrainerId)
Gets the
QueueConstrainer specified by its Id. |
QueueConstrainerList |
getQueueConstrainers()
Gets all
QueueConstrainers. |
QueueConstrainerList |
getQueueConstrainersByGenusType(Type queueConstrainerGenusType)
Gets a
QueueConstrainerList corresponding to the given
queue constrainer genus Type which does not include
queue constrainer of genus types derived from the specified
Type. |
QueueConstrainerList |
getQueueConstrainersByIds(IdList queueConstrainerIds)
Gets a
QueueConstrainerList corresponding to the given
IdList. |
QueueConstrainerList |
getQueueConstrainersByParentGenusType(Type queueConstrainerGenusType)
Gets a
QueueConstrainerList corresponding to the given
queue constrainer genus Type and include any additional
queue constrainer with genus types derived from the specified
Type. |
QueueConstrainerList |
getQueueConstrainersByRecordType(Type queueConstrainerRecordType)
Gets a
QueueConstrainerList containing the given queue
constrainer record Type. |
void |
useActiveQueueConstrainerView()
Only active queue constrainers are returned by methods in this
session.
|
void |
useAnyStatusQueueConstrainerView()
All active and inactive queue constrainers are returned by methods in
this session.
|
void |
useComparativeQueueConstrainerView()
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 |
useFederatedFrontOfficeView()
Federates the view for methods in this session.
|
void |
useIsolatedFrontOfficeView()
Isolates the view for methods in this session.
|
void |
usePlenaryQueueConstrainerView()
A complete view of the
QueueConstrainer returns is
desired. |
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 canLookupQueueConstrainers()
QueueConstrainers
lookups. A return of true does not guarantee successful authorization.
A return of false indicates that it is known all methods in this
session will result in a PERMISSION_DENIED.
This is
intended as a hint to an application that may opt not to offer lookup
operations to unauthorized users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeQueueConstrainerView()
mandatory
- This method is must be implemented. void usePlenaryQueueConstrainerView()
QueueConstrainer
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. void useFederatedFrontOfficeView()
mandatory
- This method is must be implemented. void useIsolatedFrontOfficeView()
mandatory
- This method is must be implemented. void useActiveQueueConstrainerView()
mandatory
- This method is must be implemented. void useAnyStatusQueueConstrainerView()
mandatory
- This method is must be implemented. QueueConstrainer getQueueConstrainer(Id queueConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
QueueConstrainer
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
QueueConstrainer
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a QueueConstrainer
and retained for
compatibility.
In active mode, queue constrainers are returned that are currently
active. In any status mode, active and inactive queue constrainers are
returned.queueConstrainerId
- Id
of the
QueueConstrainer
NotFoundException
- queueConstrainerId
not foundNullArgumentException
- queueConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. QueueConstrainerList getQueueConstrainersByIds(IdList queueConstrainerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
QueueConstrainerList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
queue constrainer specified in the Id
list, in the
order of the list, including duplicates, or an error results if a
Id
in the supplied list is not found or inaccessible.
Otherwise, inaccessible QueueConstrainers
may be
omitted from the list and may present the elements in any order
including returning a unique set.
In active mode, queue constrainers are returned that are currently
active. In any status mode, active and inactive queue constrainers are
returned.queueConstrainerIds
- the list of Ids
to retrieve QueueConstrainer
listNotFoundException
- a Id
was not foundNullArgumentException
- queueConstrainerIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. QueueConstrainerList getQueueConstrainersByGenusType(Type queueConstrainerGenusType) throws OperationFailedException, PermissionDeniedException
QueueConstrainerList
corresponding to the given
queue constrainer genus Type
which does not include
queue constrainer of genus types derived from the specified
Type.
In plenary mode, the returned list contains all known
queue constrainer or an error results. Otherwise, the returned list
may contain only those queue constrainer that are accessible through
this session.
In active mode, queue constrainers are returned that are currently
active. In any status mode, active and inactive queue constrainers are
returned.queueConstrainerGenusType
- a queue constrainer genus type QueueConstrainer
listNullArgumentException
-
queueConstrainerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. QueueConstrainerList getQueueConstrainersByParentGenusType(Type queueConstrainerGenusType) throws OperationFailedException, PermissionDeniedException
QueueConstrainerList
corresponding to the given
queue constrainer genus Type
and include any additional
queue constrainer with genus types derived from the specified
Type.
In plenary mode, the returned list contains all known
queue constrainer or an error results. Otherwise, the returned list
may contain only those queue constrainer that are accessible through
this session.
In active mode, queue constrainers are returned that are currently
active. In any status mode, active and inactive queue constrainers are
returned.queueConstrainerGenusType
- a queue constrainer genus type QueueConstrainer
listNullArgumentException
-
queueConstrainerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. QueueConstrainerList getQueueConstrainersByRecordType(Type queueConstrainerRecordType) throws OperationFailedException, PermissionDeniedException
QueueConstrainerList
containing the given queue
constrainer record Type.
In plenary mode, the returned list contains all known
queue constrainer or an error results. Otherwise, the returned list
may contain only those queue constrainer that are accessible through
this session.
In active mode, queue constrainers are returned that are currently
active. In any status mode, active and inactive queue constrainers are
returned.queueConstrainerRecordType
- a queue constrainer record type QueueConstrainer
listNullArgumentException
-
queueConstrainerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. QueueConstrainerList getQueueConstrainers() throws OperationFailedException, PermissionDeniedException
QueueConstrainers.
In plenary mode, the returned list contains all known queue
constrainer or an error results. Otherwise, the returned list may
contain only those queue constrainer that are accessible through this
session.
In active mode, queue constrainers are returned that are currently
active. In any status mode, active and inactive queue constrainers are
returned. QueueConstrainer
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.