public interface BrokerProcessorLookupSession extends OsidSession
This session provides methods for retrieving BrokerProcessors.
This session defines views that offer differing behaviors when retrieving multiple objects.
BrokerProcessors
with the
BrokerProcessorAdminSession.
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 |
canLookupBrokerProcessors()
Tests if this user can perform
BrokerProcessors
lookups. |
BrokerProcessor |
getBrokerProcessor(Id brokerProcessorId)
Gets the
BrokerProcessor specified by its Id. |
BrokerProcessorList |
getBrokerProcessors()
Gets all
BrokerProcessors. |
BrokerProcessorList |
getBrokerProcessorsByGenusType(Type brokerProcessorGenusType)
Gets a
BrokerProcessorList corresponding to the given
broker processor genus Type which does not include
broker processor of genus types derived from the specified
Type. |
BrokerProcessorList |
getBrokerProcessorsByIds(IdList brokerProcessorIds)
Gets a
BrokerProcessorList corresponding to the given
IdList. |
BrokerProcessorList |
getBrokerProcessorsByParentGenusType(Type brokerProcessorGenusType)
Gets a
BrokerProcessorList corresponding to the given
broker processor genus Type and include any additional
broker processor with genus types derived from the specified
Type. |
BrokerProcessorList |
getBrokerProcessorsByRecordType(Type brokerProcessorRecordType)
Gets a
BrokerProcessorList containing the given broker
processor record Type. |
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
void |
useActiveBrokerProcessorView()
Only active broker processors are returned by methods in this session.
|
void |
useAnyStatusBrokerProcessorView()
All active and inactive broker processors are returned by methods in
this session.
|
void |
useComparativeBrokerProcessorView()
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 |
usePlenaryBrokerProcessorView()
A complete view of the
BrokerProcessor 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 canLookupBrokerProcessors()
BrokerProcessors
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 useComparativeBrokerProcessorView()
mandatory
- This method is must be implemented. void usePlenaryBrokerProcessorView()
BrokerProcessor
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 useActiveBrokerProcessorView()
mandatory
- This method is must be implemented. void useAnyStatusBrokerProcessorView()
mandatory
- This method is must be implemented. BrokerProcessor getBrokerProcessor(Id brokerProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
BrokerProcessor
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
BrokerProcessor
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a BrokerProcessor
and retained for
compatibility.
In active mode, broker processors are returned that are currently
active. In any status mode, active and inactive broker processors are
returned.brokerProcessorId
- Id
of the
BrokerProcessor
NotFoundException
- brokerProcessorId
not foundNullArgumentException
- brokerProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. BrokerProcessorList getBrokerProcessorsByIds(IdList brokerProcessorIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
BrokerProcessorList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
broker processor 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 BrokerProcessors
may be omitted from the
list and may present the elements in any order including returning a
unique set.
In active mode, broker processors are returned that are currently
active. In any status mode, active and inactive broker processors are
returned.brokerProcessorIds
- the list of Ids
to retrieve BrokerProcessor
listNotFoundException
- an Id
was not foundNullArgumentException
- brokerProcessorIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BrokerProcessorList getBrokerProcessorsByGenusType(Type brokerProcessorGenusType) throws OperationFailedException, PermissionDeniedException
BrokerProcessorList
corresponding to the given
broker processor genus Type
which does not include
broker processor of genus types derived from the specified
Type.
In plenary mode, the returned list contains all known
broker processor or an error results. Otherwise, the returned list may
contain only those broker processor that are accessible through this
session.
In active mode, broker processors are returned that are currently
active. In any status mode, active and inactive broker processors are
returned.brokerProcessorGenusType
- a broker processor genus type BrokerProcessor
listNullArgumentException
- brokerProcessorGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BrokerProcessorList getBrokerProcessorsByParentGenusType(Type brokerProcessorGenusType) throws OperationFailedException, PermissionDeniedException
BrokerProcessorList
corresponding to the given
broker processor genus Type
and include any additional
broker processor with genus types derived from the specified
Type.
In plenary mode, the returned list contains all known
broker processor or an error results. Otherwise, the returned list may
contain only those broker processor that are accessible through this
session.
In active mode, broker processors are returned that are currently
active. In any status mode, active and inactive broker processors are
returned.brokerProcessorGenusType
- a broker processor genus type BrokerProcessor
listNullArgumentException
- brokerProcessorGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BrokerProcessorList getBrokerProcessorsByRecordType(Type brokerProcessorRecordType) throws OperationFailedException, PermissionDeniedException
BrokerProcessorList
containing the given broker
processor record Type.
In plenary mode, the returned list contains all known
broker processor or an error results. Otherwise, the returned list may
contain only those broker processor that are accessible through this
session.
In active mode, broker processors are returned that are currently
active. In any status mode, active and inactive broker processors are
returned.brokerProcessorRecordType
- a broker processor record type BrokerProcessor
listNullArgumentException
-
brokerProcessorRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. BrokerProcessorList getBrokerProcessors() throws OperationFailedException, PermissionDeniedException
BrokerProcessors.
In plenary mode, the returned list contains all known broker processor
or an error results. Otherwise, the returned list may contain only
those broker processor that are accessible through this session.
In active mode, broker processors are returned that are currently
active. In any status mode, active and inactive broker processors are
returned. BrokerProcessor
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.