public interface BrokerProcessorEnablerQuerySession extends OsidSession
This session provides methods for searching among
BrokerProcessorEnabler
objects. The search query is constructed
using the BrokerProcessorEnablerQuery.
This session defines views that offer differing behaviors for searching.
Broker processor enablers may have a query record indicated by their
respective record types. The query record is accessed via the
BrokerProcessorEnablerQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchBrokerProcessorEnablers()
Tests if this user can perform
BrokerProcessorEnabler
lookups. |
BrokerProcessorEnablerQuery |
getBrokerProcessorEnablerQuery()
Gets a broker processor enabler query.
|
BrokerProcessorEnablerList |
getBrokerProcessorEnablersByQuery(BrokerProcessorEnablerQuery brokerProcessorEnablerQuery)
Gets a list of
BrokerProcessorEnablers matching the
given search. |
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
void |
useFederatedDistributorView()
Federates the view for methods in this session.
|
void |
useIsolatedDistributorView()
Isolates the view for methods in this session.
|
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 canSearchBrokerProcessorEnablers()
BrokerProcessorEnabler
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 not offer lookup
operations to unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedDistributorView()
mandatory
- This method is must be implemented. void useIsolatedDistributorView()
mandatory
- This method is must be implemented. BrokerProcessorEnablerQuery getBrokerProcessorEnablerQuery()
mandatory
- This method must be implemented. BrokerProcessorEnablerList getBrokerProcessorEnablersByQuery(BrokerProcessorEnablerQuery brokerProcessorEnablerQuery) throws OperationFailedException, PermissionDeniedException
BrokerProcessorEnablers
matching the
given search.brokerProcessorEnablerQuery
- the search query BrokerProcessorEnablerList
NullArgumentException
-
brokerProcessorEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
-
brokerProcessorEnablerQuery
is not of this servicemandatory
- This method must be implemented.