org.osid.provisioning.rules

Interface BrokerConstrainerSmartDistributorSession

All Superinterfaces:

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

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.

Method Summary

Methods

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.

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.

getBrokerConstrainerQuery

BrokerConstrainerQuery getBrokerConstrainerQuery()

Gets a broker constrainer query.

Returns:

the broker constrainer query

Compliance:

mandatory - This method must be implemented.

getBrokerConstrainerSearchOrder

BrokerConstrainerSearchOrder getBrokerConstrainerSearchOrder()

Gets a broker constrainer search order.

Returns:

the broker constrainer search order

Compliance:

mandatory - This method must be implemented.

applyBrokerConstrainerQuery

void applyBrokerConstrainerQuery(BrokerConstrainerQuery brokerConstrainerQuery)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Applies a broker constrainer query to this distributor.

Parameters:

brokerConstrainerQuery - the broker constrainer query

Throws:

NullArgumentException - brokerConstrainerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - brokerConstrainerQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectBrokerConstrainerQuery

BrokerConstrainerQueryInspector inspectBrokerConstrainerQuery()
                                                              throws OperationFailedException,
                                                                     PermissionDeniedException

Gets a broker constrainer query inspector for this distributor.

Returns:

the broker constrainer query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyBrokerConstrainerSequencing

void applyBrokerConstrainerSequencing(BrokerConstrainerSearchOrder brokerConstrainerSearchOrder)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Applies a broker constrainer search order to this distributor.

Parameters:

brokerConstrainerSearchOrder - the broker constrainer search order

Throws:

NullArgumentException - brokerConstrainerSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - brokerConstrainerSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getBrokerConstrainerQueryFromInspector

BrokerConstrainerQuery getBrokerConstrainerQueryFromInspector(BrokerConstrainerQueryInspector brokerConstrainerQueryInspector)

Gets a broker constrainer query from an inspector.

Parameters:

brokerConstrainerQueryInspector - a broker constrainer query inspector

Returns:

the broker constrainer query

Throws:

NullArgumentException - brokerConstrainerQueryInspector is null

UnsupportedException - brokerConstrainerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.