public interface PoolProcessorEnablerLookupSession extends OsidSession
This session provides methods for retrieving
PoolProcessorEnablers.
This session defines views that offer differing behaviors when retrieving multiple objects.
PoolProcessorEnablers
with the
PoolProcessorEnablerAdminSession.
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 |
canLookupPoolProcessorEnablers()
Tests if this user can perform
PoolProcessorEnablers
lookups. |
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
PoolProcessorEnabler |
getPoolProcessorEnabler(Id poolProcessorEnablerId)
Gets the
PoolProcessorEnabler specified by its
Id. |
PoolProcessorEnablerList |
getPoolProcessorEnablers()
Gets all
PoolProcessorEnablers. |
PoolProcessorEnablerList |
getPoolProcessorEnablersByGenusType(Type poolProcessorEnablerGenusType)
Gets a
PoolProcessorEnablerList corresponding to the
given pool processor enabler genus Type which does not
include pool processor enablers of genus types derived from the
specified Type. |
PoolProcessorEnablerList |
getPoolProcessorEnablersByIds(IdList poolProcessorEnablerIds)
Gets a
PoolProcessorEnablerList corresponding to the
given IdList. |
PoolProcessorEnablerList |
getPoolProcessorEnablersByParentGenusType(Type poolProcessorEnablerGenusType)
Gets a
PoolProcessorEnablerList corresponding to the
given pool processor enabler genus Type and include any
additional pool processor enablers with genus types derived from the
specified Type. |
PoolProcessorEnablerList |
getPoolProcessorEnablersByRecordType(Type poolProcessorEnablerRecordType)
Gets a
PoolProcessorEnablerList containing the given
pool processor enabler record Type. |
PoolProcessorEnablerList |
getPoolProcessorEnablersOnDate(DateTime from,
DateTime to)
Gets a
PoolProcessorEnablerList effective for the
entire the given date range inclusive but not confisned to the date
range for any agent. |
PoolProcessorEnablerList |
getPoolProcessorEnablersOnDateWithAgent(Id agentId,
DateTime from,
DateTime to)
Gets a
PoolProcessorEnablerList effective for the
entire the given date range inclusive but not confisned to the date
range and evaluated against the given agent. |
void |
useActivePoolProcessorEnablerView()
Only active pool processor enablers are returned by methods in this
session.
|
void |
useAnyStatusPoolProcessorEnablerView()
All active and inactive pool processor enablers are returned by
methods in this session.
|
void |
useComparativePoolProcessorEnablerView()
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 |
usePlenaryPoolProcessorEnablerView()
A complete view of the
PoolProcessorEnabler 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 canLookupPoolProcessorEnablers()
PoolProcessorEnablers
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 useComparativePoolProcessorEnablerView()
mandatory
- This method is must be implemented. void usePlenaryPoolProcessorEnablerView()
PoolProcessorEnabler
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 useActivePoolProcessorEnablerView()
mandatory
- This method is must be implemented. void useAnyStatusPoolProcessorEnablerView()
mandatory
- This method is must be implemented. PoolProcessorEnabler getPoolProcessorEnabler(Id poolProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
PoolProcessorEnabler
specified by its
Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
PoolProcessorEnabler
may have a different Id
than requested, such as the case where a duplicate Id
was assigned to a PoolProcessorEnabler
and retained for
compatibility.
In active mode, pool processor enablers are returned that are
currently active. In any status mode, active and inactive pool
processor enablers are returned.poolProcessorEnablerId
- Id
of the
PoolProcessorEnabler
NotFoundException
- poolProcessorEnablerId
not foundNullArgumentException
- poolProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. PoolProcessorEnablerList getPoolProcessorEnablersByIds(IdList poolProcessorEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
PoolProcessorEnablerList
corresponding to the
given IdList.
In plenary mode, the returned list contains all of the
pool processor enablers specified in the Id
list, in
the order of the list, including duplicates, or an error results if an
Id
in the supplied list is not found or inaccessible.
Otherwise, inaccessible PoolProcessorEnablers
may be
omitted from the list and may present the elements in any order
including returning a unique set.
In active mode, pool processor enablers are returned that are
currently active. In any status mode, active and inactive pool
processor enablers are returned.poolProcessorEnablerIds
- the list of Ids
to
retrieve PoolProcessorEnabler
listNotFoundException
- an Id
was not foundNullArgumentException
- poolProcessorEnablerIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PoolProcessorEnablerList getPoolProcessorEnablersByGenusType(Type poolProcessorEnablerGenusType) throws OperationFailedException, PermissionDeniedException
PoolProcessorEnablerList
corresponding to the
given pool processor enabler genus Type
which does not
include pool processor enablers of genus types derived from the
specified Type.
In plenary mode, the returned list contains all known
pool processor enablers or an error results. Otherwise, the returned
list may contain only those pool processor enablers that are
accessible through this session.
In active mode, pool processor enablers are returned that are
currently active. In any status mode, active and inactive pool
processor enablers are returned.poolProcessorEnablerGenusType
- a pool processor enabler genus
type PoolProcessorEnabler
listNullArgumentException
-
poolProcessorEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PoolProcessorEnablerList getPoolProcessorEnablersByParentGenusType(Type poolProcessorEnablerGenusType) throws OperationFailedException, PermissionDeniedException
PoolProcessorEnablerList
corresponding to the
given pool processor enabler genus Type
and include any
additional pool processor enablers with genus types derived from the
specified Type.
In plenary mode, the returned list contains all known
pool processor enablers or an error results. Otherwise, the returned
list may contain only those pool processor enablers that are
accessible through this session.
In active mode, pool processor enablers are returned that are
currently active. In any status mode, active and inactive pool
processor enablers are returned.poolProcessorEnablerGenusType
- a pool processor enabler genus
type PoolProcessorEnabler
listNullArgumentException
-
poolProcessorEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PoolProcessorEnablerList getPoolProcessorEnablersByRecordType(Type poolProcessorEnablerRecordType) throws OperationFailedException, PermissionDeniedException
PoolProcessorEnablerList
containing the given
pool processor enabler record Type.
In plenary mode, the returned list contains all known
pool processor enablers or an error results. Otherwise, the returned
list may contain only those pool processor enablers that are
accessible through this session.
In active mode, pool processor enablers are returned that are
currently active. In any status mode, active and inactive pool
processor enablers are returned.poolProcessorEnablerRecordType
- a pool processor enabler record
type PoolProcessorEnabler
listNullArgumentException
-
poolProcessorEnablerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PoolProcessorEnablerList getPoolProcessorEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
PoolProcessorEnablerList
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
pool processor enablers or an error results. Otherwise, the returned
list may contain only those pool processor enablers that are
accessible through this session.
In active mode, pool processor enablers are returned that are
currently active in addition to being effective for the given date
range. In any status mode, active and inactive pool processor enablers
are returned.from
- a start dateto
- an end date PoolProcessorEnabler
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PoolProcessorEnablerList getPoolProcessorEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
PoolProcessorEnablerList
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
pool processor enablers or an error results. Otherwise, the returned
list may contain only those pool processor enablers that are
accessible through this session.
In active mode, pool processor enablers are returned that are
currently active in addition to being effective for the given date
range. In any status mode, active and inactive pool processor enablers
are returned.agentId
- an agent Idfrom
- a start dateto
- an end date PoolProcessorEnabler
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- agentId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PoolProcessorEnablerList getPoolProcessorEnablers() throws OperationFailedException, PermissionDeniedException
PoolProcessorEnablers.
In plenary mode, the returned list contains all known pool processor
enablers or an error results. Otherwise, the returned list may contain
only those pool processor enablers that are accessible through this
session.
In active mode, pool processor enablers are returned that are
currently active. In any status mode, active and inactive pool
processor enablers are returned. PoolProcessorEnabler
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.