public interface BrokerConstrainerSmartDistributorSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
distributors. A BrokerConstrainerQuery
can be retrieved
from this session and mapped to this Distributor
to create
a virtual collection of broker constrainers. The broker constrainer may be
sequenced using the BrokerConstrainerSearchOrder
from this
session.
This Distributor
has a default query that matches any
broker constrainer and a default search order that specifies no
sequencing. The queries may be examined using a
BrokerConstrainerQueryInspector.
The query may be modified by
converting the inspector back to a BrokerConstrainerQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyBrokerConstrainerQuery(BrokerConstrainerQuery brokerConstrainerQuery)
Applies a broker constrainer query to this distributor.
|
void |
applyBrokerConstrainerSequencing(BrokerConstrainerSearchOrder brokerConstrainerSearchOrder)
Applies a broker constrainer search order to this distributor.
|
boolean |
canManageSmartDistributors()
Tests if this user can manage smart distributors.
|
BrokerConstrainerQuery |
getBrokerConstrainerQuery()
Gets a broker constrainer query.
|
BrokerConstrainerQuery |
getBrokerConstrainerQueryFromInspector(BrokerConstrainerQueryInspector brokerConstrainerQueryInspector)
Gets a broker constrainer query from an inspector.
|
BrokerConstrainerSearchOrder |
getBrokerConstrainerSearchOrder()
Gets a broker constrainer search order.
|
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
BrokerConstrainerQueryInspector |
inspectBrokerConstrainerQuery()
Gets a broker constrainer 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. BrokerConstrainerQuery getBrokerConstrainerQuery()
mandatory
- This method must be implemented. BrokerConstrainerSearchOrder getBrokerConstrainerSearchOrder()
mandatory
- This method must be implemented. void applyBrokerConstrainerQuery(BrokerConstrainerQuery brokerConstrainerQuery) throws OperationFailedException, PermissionDeniedException
brokerConstrainerQuery
- the broker constrainer queryNullArgumentException
- brokerConstrainerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- brokerConstrainerQuery
not of this servicemandatory
- This method must be implemented. BrokerConstrainerQueryInspector inspectBrokerConstrainerQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyBrokerConstrainerSequencing(BrokerConstrainerSearchOrder brokerConstrainerSearchOrder) throws OperationFailedException, PermissionDeniedException
brokerConstrainerSearchOrder
- the broker constrainer search
orderNullArgumentException
-
brokerConstrainerSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
brokerConstrainerSearchOrder
not of this servicemandatory
- This method must be implemented. BrokerConstrainerQuery getBrokerConstrainerQueryFromInspector(BrokerConstrainerQueryInspector brokerConstrainerQueryInspector)
brokerConstrainerQueryInspector
- a broker constrainer query
inspectorNullArgumentException
-
brokerConstrainerQueryInspector
is null
UnsupportedException
-
brokerConstrainerQueryInspector
is not of this servicemandatory
- This method must be implemented.