public interface BrokerProcessorEnablerSmartDistributorSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
distributors. A BrokerProcessorEnablerQuery
can be
retrieved from this session and mapped to this Distributor
to create a virtual collection of broker processor enablers. The broker
processor enablers may be sequenced using the
BrokerProcessorEnablerSearchOrder
from this session.
This Distributor
has a default query that matches any
broker processor enabler and a default search order that specifies no
sequencing. The queries may be examined using a
BrokerProcessorEnablerQueryInspector.
The query may be modified by
converting the inspector back to a BrokerProcessorEnablerQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyBrokerProcessorEnablerQuery(BrokerProcessorEnablerQuery brokerProcessorEnablerQuery)
Applies a broker processor enabler query to this distributor.
|
void |
applyBrokerProcessorEnablerSequencing(BrokerProcessorEnablerSearchOrder brokerProcessorEnablerSearchOrder)
Applies a broker processor enabler search order to this distributor.
|
boolean |
canManageSmartDistributors()
Tests if this user can manage smart distributors.
|
BrokerProcessorEnablerQuery |
getBrokerProcessorEnablerQuery()
Gets a broker processor enabler query.
|
BrokerProcessorEnablerQuery |
getBrokerProcessorEnablerQueryFromInspector(BrokerProcessorEnablerQueryInspector brokerProcessorEnablerQueryInspector)
Gets a broker processor enabler query from an inspector.
|
BrokerProcessorEnablerSearchOrder |
getBrokerProcessorEnablerSearchOrder()
Gets a broker processor enabler search order.
|
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
BrokerProcessorEnablerQueryInspector |
inspectBrokerProcessorEnablerQuery()
Gets a broker processor enabler query inspector for this distributor.
|
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 canManageSmartDistributors()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart distributor management is not
authorized, true
otherwisemandatory
- This method must be implemented. BrokerProcessorEnablerQuery getBrokerProcessorEnablerQuery()
mandatory
- This method must be implemented. BrokerProcessorEnablerSearchOrder getBrokerProcessorEnablerSearchOrder()
mandatory
- This method must be implemented. void applyBrokerProcessorEnablerQuery(BrokerProcessorEnablerQuery brokerProcessorEnablerQuery) throws OperationFailedException, PermissionDeniedException
brokerProcessorEnablerQuery
- the broker processor enabler queryNullArgumentException
-
brokerProcessorEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
brokerProcessorEnablerQuery
not of this servicemandatory
- This method must be implemented. BrokerProcessorEnablerQueryInspector inspectBrokerProcessorEnablerQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyBrokerProcessorEnablerSequencing(BrokerProcessorEnablerSearchOrder brokerProcessorEnablerSearchOrder) throws OperationFailedException, PermissionDeniedException
brokerProcessorEnablerSearchOrder
- the broker processor enabler
search orderNullArgumentException
-
brokerProcessorEnablerSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
brokerProcessorEnablerSearchOrder
not of this servicemandatory
- This method must be implemented. BrokerProcessorEnablerQuery getBrokerProcessorEnablerQueryFromInspector(BrokerProcessorEnablerQueryInspector brokerProcessorEnablerQueryInspector)
brokerProcessorEnablerQueryInspector
- a broker processor
enabler query inspectorNullArgumentException
-
brokerProcessorEnablerQueryInspector
is null
UnsupportedException
-
brokerProcessorEnablerQueryInspector
is not of this
servicemandatory
- This method must be implemented.