public interface QueueProcessorEnablerLookupSession extends OsidSession
This session provides methods for retrieving
QueueProcessorEnablers.
This session defines views that offer differing behaviors when retrieving multiple objects.
QueueProcessorEnablers
with the QueueProcessorEnablerAdminSession.
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 |
canLookupQueueProcessorEnablers()
Tests if this user can perform
QueueProcessorEnablers
lookups. |
FrontOffice |
getFrontOffice()
Gets the
FrontOffice associated with this session. |
Id |
getFrontOfficeId()
Gets the
FrontOffice Id associated with
this session. |
QueueProcessorEnabler |
getQueueProcessorEnabler(Id queueProcessorEnablerId)
Gets the
QueueProcessorEnabler specified by its
Id. |
QueueProcessorEnablerList |
getQueueProcessorEnablers()
Gets all
QueueProcessorEnablers. |
QueueProcessorEnablerList |
getQueueProcessorEnablersByGenusType(Type queueProcessorEnablerGenusType)
Gets a
QueueProcessorEnablerList corresponding to the
given queue processor enabler genus Type which does not
include queue processor enablers of genus types derived from the
specified Type. |
QueueProcessorEnablerList |
getQueueProcessorEnablersByIds(IdList queueProcessorEnablerIds)
Gets a
QueueProcessorEnablerList corresponding to the
given IdList. |
QueueProcessorEnablerList |
getQueueProcessorEnablersByParentGenusType(Type queueProcessorEnablerGenusType)
Gets a
QueueProcessorEnablerList corresponding to the
given queue processor enabler genus Type and include
any additional queue processor enablers with genus types derived from
the specified Type. |
QueueProcessorEnablerList |
getQueueProcessorEnablersByRecordType(Type queueProcessorEnablerRecordType)
Gets a
QueueProcessorEnablerList containing the given
queue processor enabler record Type. |
QueueProcessorEnablerList |
getQueueProcessorEnablersOnDate(DateTime from,
DateTime to)
Gets a
QueueProcessorEnablerList that are effective for
the entire given date range inclusive but not confined to the date
range for any agent. |
QueueProcessorEnablerList |
getQueueProcessorEnablersOnDateWithAgent(Id agentId,
DateTime from,
DateTime to)
Gets a
QueueProcessorEnablerList that are effective for
the entire given date range inclusive but not confined to the date
range and evaluated against the given agent. |
void |
useActiveQueueProcessorEnablerView()
Only active queue processor enablers are returned by methods in this
session.
|
void |
useAnyStatusQueueProcessorEnablerView()
All active and inactive queue processor enablers are returned by
methods in this session.
|
void |
useComparativeQueueProcessorEnablerView()
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 |
usePlenaryQueueProcessorEnablerView()
A complete view of the
QueueProcessorEnabler 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 canLookupQueueProcessorEnablers()
QueueProcessorEnablers
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 useComparativeQueueProcessorEnablerView()
mandatory
- This method is must be implemented. void usePlenaryQueueProcessorEnablerView()
QueueProcessorEnabler
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 useActiveQueueProcessorEnablerView()
mandatory
- This method is must be implemented. void useAnyStatusQueueProcessorEnablerView()
mandatory
- This method is must be implemented. QueueProcessorEnabler getQueueProcessorEnabler(Id queueProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
QueueProcessorEnabler
specified by its
Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
QueueProcessorEnabler
may have a different Id
than requested, such as the case where a duplicate Id
was assigned to a QueueProcessorEnabler
and retained
for compatibility.
In active mode, queue processor enablers are returned that are
currently active. In any status mode, active and inactive queue
processors enablers are returned.queueProcessorEnablerId
- Id
of the
QueueProcessorEnabler
NotFoundException
- queueProcessorEnablerId
not foundNullArgumentException
- queueProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. QueueProcessorEnablerList getQueueProcessorEnablersByIds(IdList queueProcessorEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
QueueProcessorEnablerList
corresponding to the
given IdList.
In plenary mode, the returned list contains all of the
queue processor 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 QueueProcessorEnablers
may be
omitted from the list and may present the elements in any order
including returning a unique set.
In active mode, queue processor enablers are returned that are
currently active. In any status mode, active and inactive queue
processors enablers are returned.queueProcessorEnablerIds
- the list of Ids
to
retrieve QueueProcessorEnabler
listNotFoundException
- a Id
was not foundNullArgumentException
- queueProcessorEnablerIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. QueueProcessorEnablerList getQueueProcessorEnablersByGenusType(Type queueProcessorEnablerGenusType) throws OperationFailedException, PermissionDeniedException
QueueProcessorEnablerList
corresponding to the
given queue processor enabler genus Type
which does not
include queue processor enablers of genus types derived from the
specified Type.
In plenary mode, the returned list contains all known
queue processor enablers or an error results. Otherwise, the returned
list may contain only those queue processor enablers that are
accessible through this session.
In active mode, queue processor enablers are returned that are
currently active. In any status mode, active and inactive queue
processors enablers are returned.queueProcessorEnablerGenusType
- a queue processor enabler genus
type QueueProcessorEnabler
listNullArgumentException
-
queueProcessorEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. QueueProcessorEnablerList getQueueProcessorEnablersByParentGenusType(Type queueProcessorEnablerGenusType) throws OperationFailedException, PermissionDeniedException
QueueProcessorEnablerList
corresponding to the
given queue processor enabler genus Type
and include
any additional queue processor enablers with genus types derived from
the specified Type.
In plenary mode, the returned list contains all known
queue processor enablers or an error results. Otherwise, the returned
list may contain only those queue processor enablers that are
accessible through this session.
In active mode, queue processor enablers are returned that are
currently active. In any status mode, active and inactive queue
processors enablers are returned.queueProcessorEnablerGenusType
- a queue processor enabler genus
type QueueProcessorEnabler
listNullArgumentException
-
queueProcessorEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. QueueProcessorEnablerList getQueueProcessorEnablersByRecordType(Type queueProcessorEnablerRecordType) throws OperationFailedException, PermissionDeniedException
QueueProcessorEnablerList
containing the given
queue processor enabler record Type.
In plenary mode, the returned list contains all known
queue processor enablers or an error results. Otherwise, the returned
list may contain only those queue processor enablers that are
accessible through this session.
In active mode, queue processor enablers are returned that are
currently active. In any status mode, active and inactive queue
processors enablers are returned.queueProcessorEnablerRecordType
- a queue processor enabler
record type QueueProcessorEnabler
listNullArgumentException
-
queueProcessorEnablerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. QueueProcessorEnablerList getQueueProcessorEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
QueueProcessorEnablerList
that are effective for
the entire given date range inclusive but not confined to the date
range for any agent.
In plenary mode, the returned list contains all known
queue processor enablers or an error results. Otherwise, the returned
list may contain only those queue processor enablers that are
accessible through this session.
In active mode, queue processor enablers are returned that are
currently active. In any status mode, active and inactive queue
processors enablers are returned.from
- a start dateto
- an end date QueueProcessorEnabler
listInvalidArgumentException
- from
is
greater tha to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. QueueProcessorEnablerList getQueueProcessorEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
QueueProcessorEnablerList
that are effective for
the entire given date range inclusive but not confined to the date
range and evaluated against the given agent.
In plenary mode, the returned list contains all known
queue processor enablers or an error results. Otherwise, the returned
list may contain only those queue processor enablers that are
accessible through this session.
In active mode, queue processor enablers are returned that are
currently active. In any status mode, active and inactive queue
processors enablers are returned.agentId
- an agent Id
from
- a start dateto
- an end date QueueProcessorEnabler
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. QueueProcessorEnablerList getQueueProcessorEnablers() throws OperationFailedException, PermissionDeniedException
QueueProcessorEnablers.
In plenary mode, the returned list contains all known queue processor
enablers or an error results. Otherwise, the returned list may contain
only those queue processor enablers that are accessible through this
session.
In active mode, queue processor enablers are returned that are
currently active. In any status mode, active and inactive queue
processors enablers are returned. QueueProcessorEnabler
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.