public interface BrokerProcessorEnablerLookupSession extends OsidSession
This session provides methods for retrieving
BrokerProcessorEnablers.
This session defines views that offer differing behaviors when retrieving multiple objects.
BrokerProcessorEnablers
with the BrokerProcessorEnablerAdminSession.
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 |
canLookupBrokerProcessorEnablers()
Tests if this user can perform
BrokerProcessorEnablers
lookups. |
BrokerProcessorEnabler |
getBrokerProcessorEnabler(Id brokerProcessorEnablerId)
Gets the
BrokerProcessorEnabler specified by its
Id. |
BrokerProcessorEnablerList |
getBrokerProcessorEnablers()
Gets all
BrokerProcessorEnablers. |
BrokerProcessorEnablerList |
getBrokerProcessorEnablersByGenusType(Type brokerProcessorEnablerGenusType)
Gets a
BrokerProcessorEnablerList corresponding to the
given broker processor enabler genus Type which does
not include broker processor enablers of genus types derived from the
specified Type. |
BrokerProcessorEnablerList |
getBrokerProcessorEnablersByIds(IdList brokerProcessorEnablerIds)
Gets a
BrokerProcessorEnablerList corresponding to the
given IdList. |
BrokerProcessorEnablerList |
getBrokerProcessorEnablersByParentGenusType(Type brokerProcessorEnablerGenusType)
Gets a
BrokerProcessorEnablerList corresponding to the
given broker processor enabler genus Type and include
any additional broker processor enablers with genus types derived from
the specified Type. |
BrokerProcessorEnablerList |
getBrokerProcessorEnablersByRecordType(Type brokerProcessorEnablerRecordType)
Gets a
BrokerProcessorEnablerList containing the given
broker processor enabler record Type. |
BrokerProcessorEnablerList |
getBrokerProcessorEnablersOnDate(DateTime from,
DateTime to)
Gets a
BrokerProcessorEnablerList effective for the
entire the given date range inclusive but not confisned to the date
range for any agent. |
BrokerProcessorEnablerList |
getBrokerProcessorEnablersOnDateWithAgent(Id agentId,
DateTime from,
DateTime to)
Gets a
BrokerProcessorEnablerList effective for the
entire the given date range inclusive but not confisned to the date
range for any agent. |
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
void |
useActiveBrokerProcessorEnablerView()
Only active broker processor enablers are returned by methods in this
session.
|
void |
useAnyStatusBrokerProcessorEnablerView()
All active and inactive broker processor enablers are returned by
methods in this session.
|
void |
useComparativeBrokerProcessorEnablerView()
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 |
usePlenaryBrokerProcessorEnablerView()
A complete view of the
BrokerProcessorEnabler 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 canLookupBrokerProcessorEnablers()
BrokerProcessorEnablers
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 useComparativeBrokerProcessorEnablerView()
mandatory
- This method is must be implemented. void usePlenaryBrokerProcessorEnablerView()
BrokerProcessorEnabler
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 useActiveBrokerProcessorEnablerView()
mandatory
- This method is must be implemented. void useAnyStatusBrokerProcessorEnablerView()
mandatory
- This method is must be implemented. BrokerProcessorEnabler getBrokerProcessorEnabler(Id brokerProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
BrokerProcessorEnabler
specified by its
Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
BrokerProcessorEnabler
may have a different Id
than requested, such as the case where a duplicate Id
was assigned to a BrokerProcessorEnabler
and retained
for compatibility.
In active mode, broker processor enablers are returned that are
currently active. In any status mode, active and inactive broker
processor enablers are returned.brokerProcessorEnablerId
- Id
of the
BrokerProcessorEnabler
NotFoundException
- brokerProcessorEnablerId
not foundNullArgumentException
- brokerProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. BrokerProcessorEnablerList getBrokerProcessorEnablersByIds(IdList brokerProcessorEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
BrokerProcessorEnablerList
corresponding to the
given IdList.
In plenary mode, the returned list contains all of the
broker 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 BrokerProcessorEnablers
may be
omitted from the list and may present the elements in any order
including returning a unique set.
In active mode, broker processor enablers are returned that are
currently active. In any status mode, active and inactive broker
processor enablers are returned.brokerProcessorEnablerIds
- the list of Ids
to
retrieve BrokerProcessorEnabler
listNotFoundException
- an Id
was not foundNullArgumentException
-
brokerProcessorEnablerIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BrokerProcessorEnablerList getBrokerProcessorEnablersByGenusType(Type brokerProcessorEnablerGenusType) throws OperationFailedException, PermissionDeniedException
BrokerProcessorEnablerList
corresponding to the
given broker processor enabler genus Type
which does
not include broker processor enablers of genus types derived from the
specified Type.
In plenary mode, the returned list contains all known
broker processor enablers or an error results. Otherwise, the returned
list may contain only those broker processor enablers that are
accessible through this session.
In active mode, broker processor enablers are returned that are
currently active. In any status mode, active and inactive broker
processor enablers are returned.brokerProcessorEnablerGenusType
- a broker processor enabler
genus type BrokerProcessorEnabler
listNullArgumentException
-
brokerProcessorEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BrokerProcessorEnablerList getBrokerProcessorEnablersByParentGenusType(Type brokerProcessorEnablerGenusType) throws OperationFailedException, PermissionDeniedException
BrokerProcessorEnablerList
corresponding to the
given broker processor enabler genus Type
and include
any additional broker processor enablers with genus types derived from
the specified Type.
In plenary mode, the returned list contains all known
broker processor enablers or an error results. Otherwise, the returned
list may contain only those broker processor enablers that are
accessible through this session.
In active mode, broker processor enablers are returned that are
currently active. In any status mode, active and inactive broker
processor enablers are returned.brokerProcessorEnablerGenusType
- a broker processor enabler
genus type BrokerProcessorEnabler
listNullArgumentException
-
brokerProcessorEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BrokerProcessorEnablerList getBrokerProcessorEnablersByRecordType(Type brokerProcessorEnablerRecordType) throws OperationFailedException, PermissionDeniedException
BrokerProcessorEnablerList
containing the given
broker processor enabler record Type.
In plenary mode, the returned list contains all known
broker processor enablers or an error results. Otherwise, the returned
list may contain only those broker processor enablers that are
accessible through this session.
In active mode, broker processor enablers are returned that are
currently active. In any status mode, active and inactive broker
processor enablers are returned.brokerProcessorEnablerRecordType
- a broker processor enabler
record type BrokerProcessorEnabler
listNullArgumentException
-
brokerProcessorEnablerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BrokerProcessorEnablerList getBrokerProcessorEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
BrokerProcessorEnablerList
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
broker processor enablers or an error results. Otherwise, the returned
list may contain only those broker processor enablers that are
accessible through this session.
In active mode, broker processor enablers are returned that are
currently active in addition to being effective during the given date
range. In any status mode, active and inactive broker processor
enablers are returned.from
- a start dateto
- an end date BrokerProcessorEnabler
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BrokerProcessorEnablerList getBrokerProcessorEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
BrokerProcessorEnablerList
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
broker processor enablers or an error results. Otherwise, the returned
list may contain only those broker processor enablers that are
accessible through this session.
In active mode, broker processor enablers are returned that are
currently active in addition to being effective during the given date
range. In any status mode, active and inactive broker processor
enablers are returned.agentId
- an agent Idfrom
- a start dateto
- an end date BrokerProcessorEnabler
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. BrokerProcessorEnablerList getBrokerProcessorEnablers() throws OperationFailedException, PermissionDeniedException
BrokerProcessorEnablers.
In plenary mode, the returned list contains all known broker processor
enablers or an error results. Otherwise, the returned list may contain
only those broker processor enablers that are accessible through this
session.
In active mode, broker processor enablers are returned that are
currently active. In any status mode, active and inactive broker
processor enablers are returned. BrokerProcessorEnabler
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.