public interface QueueConstrainerEnablerLookupSession extends OsidSession
This session provides methods for retrieving
QueueConstrainerEnablers.
This session defines views that offer differing behaviors when retrieving multiple objects.
QueueConstrainerEnablers
with the QueueConstrainerEnablerAdminSession.
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 useFederatedDistributorView()
and
useIsolatedDistributorView()
behave as a radio group and one
should be selected before invoking the methods in this session.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupQueueConstrainerEnablers()
Tests if this user can perform
QueueConstrainerEnablers
lookups. |
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
QueueConstrainerEnabler |
getQueueConstrainerEnabler(Id queueConstrainerEnablerId)
Gets the
QueueConstrainerEnabler specified by its
Id. |
QueueConstrainerEnablerList |
getQueueConstrainerEnablers()
Gets all
QueueConstrainerEnablers. |
QueueConstrainerEnablerList |
getQueueConstrainerEnablersByGenusType(Type queueConstrainerEnablerGenusType)
Gets a
QueueConstrainerEnablerList corresponding to the
given queue constrainer enabler genus Type which does
not include queue constrainer enablers of genus types derived from the
specified Type. |
QueueConstrainerEnablerList |
getQueueConstrainerEnablersByIds(IdList queueConstrainerEnablerIds)
Gets a
QueueConstrainerEnablerList corresponding to the
given IdList. |
QueueConstrainerEnablerList |
getQueueConstrainerEnablersByParentGenusType(Type queueConstrainerEnablerGenusType)
Gets a
QueueConstrainerEnablerList corresponding to the
given queue constrainer enabler genus Type and include
any additional queue constrainer enablers with genus types derived
from the specified Type. |
QueueConstrainerEnablerList |
getQueueConstrainerEnablersByRecordType(Type queueConstrainerEnablerRecordType)
Gets a
QueueConstrainerEnablerList containing the given
queue constrainer enabler record Type. |
QueueConstrainerEnablerList |
getQueueConstrainerEnablersOnDate(DateTime from,
DateTime to)
Gets a
QueueConstrainerEnablerList effective for the
entire the given date range inclusive but not confisned to the date
range for any agent. |
QueueConstrainerEnablerList |
getQueueConstrainerEnablersOnDateWithAgent(Id agentId,
DateTime from,
DateTime to)
Gets a
QueueConstrainerEnablerList effective for the
entire the given date range inclusive but not confisned to the date
range and evaluated against the given agent. |
void |
useActiveQueueConstrainerEnablerView()
Only active queue constrainer enablers are returned by methods in this
session.
|
void |
useAnyStatusQueueConstrainerEnablerView()
All active and inactive queue constrainer enablers are returned by
methods in this session.
|
void |
useComparativeQueueConstrainerEnablerView()
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 |
useFederatedDistributorView()
Federates the view for methods in this session.
|
void |
useIsolatedDistributorView()
Isolates the view for methods in this session.
|
void |
usePlenaryQueueConstrainerEnablerView()
A complete view of the
QueueConstrainerEnabler returns
is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getDistributorId()
Distributor
Id
associated with
this session. Distributor Id
associated with this sessionmandatory
- This method must be implemented. Distributor getDistributor() throws OperationFailedException, PermissionDeniedException
Distributor
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupQueueConstrainerEnablers()
QueueConstrainerEnablers
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 useComparativeQueueConstrainerEnablerView()
mandatory
- This method is must be implemented. void usePlenaryQueueConstrainerEnablerView()
QueueConstrainerEnabler
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 useFederatedDistributorView()
mandatory
- This method is must be implemented. void useIsolatedDistributorView()
mandatory
- This method is must be implemented. void useActiveQueueConstrainerEnablerView()
mandatory
- This method is must be implemented. void useAnyStatusQueueConstrainerEnablerView()
mandatory
- This method is must be implemented. QueueConstrainerEnabler getQueueConstrainerEnabler(Id queueConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
QueueConstrainerEnabler
specified by its
Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
QueueConstrainerEnabler
may have a different Id
than requested, such as the case where a duplicate Id
was assigned to a QueueConstrainerEnabler
and retained
for compatibility.
In active mode, queue constrainer enablers are returned that are
currently active. In any status mode, active and inactive queue
constrainer enablers are returned.queueConstrainerEnablerId
- Id
of the
QueueConstrainerEnabler
NotFoundException
- queueConstrainerEnablerId
not foundNullArgumentException
-
queueConstrainerEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. QueueConstrainerEnablerList getQueueConstrainerEnablersByIds(IdList queueConstrainerEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
QueueConstrainerEnablerList
corresponding to the
given IdList.
In plenary mode, the returned list contains all of the
queue constrainer enablers 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 QueueConstrainerEnablers
may be
omitted from the list and may present the elements in any order
including returning a unique set.
In active mode, queue constrainer enablers are returned that are
currently active. In any status mode, active and inactive queue
constrainer enablers are returned.queueConstrainerEnablerIds
- the list of Ids
to
retrieve QueueConstrainerEnabler
listNotFoundException
- an Id
was not foundNullArgumentException
-
queueConstrainerEnablerIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. QueueConstrainerEnablerList getQueueConstrainerEnablersByGenusType(Type queueConstrainerEnablerGenusType) throws OperationFailedException, PermissionDeniedException
QueueConstrainerEnablerList
corresponding to the
given queue constrainer enabler genus Type
which does
not include queue constrainer enablers of genus types derived from the
specified Type.
In plenary mode, the returned list contains all known
queue constrainer enablers or an error results. Otherwise, the
returned list may contain only those queue constrainer enablers that
are accessible through this session.
In active mode, queue constrainer enablers are returned that are
currently active. In any status mode, active and inactive queue
constrainer enablers are returned.queueConstrainerEnablerGenusType
- a queue constrainer enabler
genus type QueueConstrainerEnabler
listNullArgumentException
-
queueConstrainerEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. QueueConstrainerEnablerList getQueueConstrainerEnablersByParentGenusType(Type queueConstrainerEnablerGenusType) throws OperationFailedException, PermissionDeniedException
QueueConstrainerEnablerList
corresponding to the
given queue constrainer enabler genus Type
and include
any additional queue constrainer enablers with genus types derived
from the specified Type.
In plenary mode, the returned list contains all known
queue constrainer enablers or an error results. Otherwise, the
returned list may contain only those queue constrainer enablers that
are accessible through this session.
In active mode, queue constrainer enablers are returned that are
currently active. In any status mode, active and inactive queue
constrainer enablers are returned.queueConstrainerEnablerGenusType
- a queue constrainer enabler
genus type QueueConstrainerEnabler
listNullArgumentException
-
queueConstrainerEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. QueueConstrainerEnablerList getQueueConstrainerEnablersByRecordType(Type queueConstrainerEnablerRecordType) throws OperationFailedException, PermissionDeniedException
QueueConstrainerEnablerList
containing the given
queue constrainer enabler record Type.
In plenary mode, the returned list contains all known
queue constrainer enablers or an error results. Otherwise, the
returned list may contain only those queue constrainer enablers that
are accessible through this session.
In active mode, queue constrainer enablers are returned that are
currently active. In any status mode, active and inactive queue
constrainer enablers are returned.queueConstrainerEnablerRecordType
- a queue constrainer enabler
record type QueueConstrainerEnabler
listNullArgumentException
-
queueConstrainerEnablerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. QueueConstrainerEnablerList getQueueConstrainerEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
QueueConstrainerEnablerList
effective for the
entire the given date range inclusive but not confisned to the date
range for any agent.
In plenary mode, the returned list contains all known
queue constrainer enablers or an error results. Otherwise, the
returned list may contain only those queue constrainer enablers that
are accessible through this session.
In active mode, queue constrainer enablers are returned that are
currently active in addition to being active for the given date range.
In any status mode, active and inactive queue constrainer enablers are
returned.from
- a start dateto
- an end date QueueConstrainerEnabler
listInvalidArgumentException
- from
is
greater tha to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. QueueConstrainerEnablerList getQueueConstrainerEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
QueueConstrainerEnablerList
effective for the
entire the given date range inclusive but not confisned to the date
range and evaluated against the given agent.
In plenary mode, the returned list contains all known
queue constrainer enablers or an error results. Otherwise, the
returned list may contain only those queue constrainer enablers that
are accessible through this session.
In active mode, queue constrainer enablers are returned that are
currently active in addition to being active for the given date range.
In any status mode, active and inactive queue constrainer enablers are
returned.agentId
- an agent Idfrom
- a start dateto
- an end date QueueConstrainerEnabler
listInvalidArgumentException
- from
is
greater tha to
NullArgumentException
- agentId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. QueueConstrainerEnablerList getQueueConstrainerEnablers() throws OperationFailedException, PermissionDeniedException
QueueConstrainerEnablers.
In plenary mode, the returned list contains all known queue
constrainer enablers or an error results. Otherwise, the returned list
may contain only those queue constrainer enablers that are accessible
through this session.
In active mode, queue constrainer enablers are returned that are
currently active. In any status mode, active and inactive queue
constrainer enablers are returned. QueueConstrainerEnabler
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.