public interface BrokerSmartDistributorSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A BrokerQuery
can be retrieved from this session
and mapped to this Distributor
to create a virtual
collection of Brokers.
The brokers may be sequenced using
the BrokerSearchOrder
from this session.
This Distributor
has a default query that matches any
broker and a default search order that specifies no sequencing. The
queries may be examined using a BrokerQueryInspector.
The
query may be modified by converting the inspector back to a
BrokerQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyBrokerQuery(BrokerQuery brokerQuery)
Applies a broker query to this distributor.
|
void |
applyBrokerSequencing(BrokerSearchOrder brokerSearchOrder)
Applies a broker search order to this distributor.
|
boolean |
canManageSmartDistributors()
Tests if this user can manage smart distributors.
|
BrokerQuery |
getBrokerQuery()
Gets a broker query.
|
BrokerQuery |
getBrokerQueryFromInspector(BrokerQueryInspector brokerQueryInspector)
Gets a broker query from an inspector.
|
BrokerSearchOrder |
getBrokerSearchOrder()
Gets a broker search order.
|
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
BrokerQueryInspector |
inspectBrokerQuery()
Gets a broker 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. BrokerQuery getBrokerQuery()
mandatory
- This method must be implemented. BrokerSearchOrder getBrokerSearchOrder()
mandatory
- This method must be implemented. void applyBrokerQuery(BrokerQuery brokerQuery) throws OperationFailedException, PermissionDeniedException
brokerQuery
- the broker queryNullArgumentException
- brokerQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- brokerQuery
not
of this servicemandatory
- This method must be implemented. BrokerQueryInspector inspectBrokerQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyBrokerSequencing(BrokerSearchOrder brokerSearchOrder) throws OperationFailedException, PermissionDeniedException
brokerSearchOrder
- the broker search orderNullArgumentException
- brokerSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- brokerSearchOrder
not of this servicemandatory
- This method must be implemented. BrokerQuery getBrokerQueryFromInspector(BrokerQueryInspector brokerQueryInspector)
brokerQueryInspector
- a broker query inspectorNullArgumentException
- brokerQueryInspector
is null
UnsupportedException
- brokerQueryInspector
is not of this servicemandatory
- This method must be implemented.