org.osid.provisioning

Interface BrokerSmartDistributorSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getDistributorId

Id getDistributorId()

Gets the Distributor Id associated with this session.

Returns:

the Distributor Id associated with this session

Compliance:

mandatory - This method must be implemented.

getDistributor

Distributor getDistributor()
                           throws OperationFailedException,
                                  PermissionDeniedException

Gets the Distributor associated with this session.

Returns:

the distributor

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageSmartDistributors

boolean canManageSmartDistributors()

Tests if this user can manage smart distributors. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.

Returns:

false if smart distributor management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getBrokerQuery

BrokerQuery getBrokerQuery()

Gets a broker query.

Returns:

the broker query

Compliance:

mandatory - This method must be implemented.

getBrokerSearchOrder

BrokerSearchOrder getBrokerSearchOrder()

Gets a broker search order.

Returns:

the broker search order

Compliance:

mandatory - This method must be implemented.

applyBrokerQuery

void applyBrokerQuery(BrokerQuery brokerQuery)
                      throws OperationFailedException,
                             PermissionDeniedException

Applies a broker query to this distributor.

Parameters:

brokerQuery - the broker query

Throws:

NullArgumentException - brokerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - brokerQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectBrokerQuery

BrokerQueryInspector inspectBrokerQuery()
                                        throws OperationFailedException,
                                               PermissionDeniedException

Gets a broker query inspector for this distributor.

Returns:

the broker query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyBrokerSequencing

void applyBrokerSequencing(BrokerSearchOrder brokerSearchOrder)
                           throws OperationFailedException,
                                  PermissionDeniedException

Applies a broker search order to this distributor.

Parameters:

brokerSearchOrder - the broker search order

Throws:

NullArgumentException - brokerSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - brokerSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getBrokerQueryFromInspector

BrokerQuery getBrokerQueryFromInspector(BrokerQueryInspector brokerQueryInspector)

Gets a broker query from an inspector.

Parameters:

brokerQueryInspector - a broker query inspector

Returns:

the broker query

Throws:

NullArgumentException - brokerQueryInspector is null

UnsupportedException - brokerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.