org.osid.provisioning.rules

Interface PoolProcessorSmartDistributorSession

All Superinterfaces:

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

public interface PoolProcessorSmartDistributorSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic distributors. A PoolProcessorQuery can be retrieved from this session and mapped to this Distributor to create a virtual collection of pool processors. The pool processor may be sequenced using the PoolProcessorSearchOrder from this session.

This Distributor has a default query that matches any pool processor and a default search order that specifies no sequencing. The queries may be examined using a PoolProcessorQueryInspector. The query may be modified by converting the inspector back to a PoolProcessorQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyPoolProcessorQuery(PoolProcessorQuery poolProcessorQuery) Applies a pool processor query to this distributor.
void	applyPoolProcessorSequencing(PoolProcessorSearchOrder poolProcessorSearchOrder) Applies a pool processor search order to this distributor.
boolean	canManageSmartDistributors() Tests if this user can manage smart distributors.
Distributor	getDistributor() Gets the Distributor associated with this session.
Id	getDistributorId() Gets the Distributor Id associated with this session.
PoolProcessorQuery	getPoolProcessorQuery() Gets a pool processor query.
PoolProcessorQuery	getPoolProcessorQueryFromInspector(PoolProcessorQueryInspector poolProcessorQueryInspector) Gets a pool processor query from an inspector.
PoolProcessorSearchOrder	getPoolProcessorSearchOrder() Gets a pool processor search order.
PoolProcessorQueryInspector	inspectPoolProcessorQuery() Gets a pool processor 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.

getPoolProcessorQuery

PoolProcessorQuery getPoolProcessorQuery()

Gets a pool processor query.

Returns:

the pool processor query

Compliance:

mandatory - This method must be implemented.

getPoolProcessorSearchOrder

PoolProcessorSearchOrder getPoolProcessorSearchOrder()

Gets a pool processor search order.

Returns:

the pool processor search order

Compliance:

mandatory - This method must be implemented.

applyPoolProcessorQuery

void applyPoolProcessorQuery(PoolProcessorQuery poolProcessorQuery)
                             throws OperationFailedException,
                                    PermissionDeniedException

Applies a pool processor query to this distributor.

Parameters:

poolProcessorQuery - the pool processor query

Throws:

NullArgumentException - poolProcessorQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - poolProcessorQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectPoolProcessorQuery

PoolProcessorQueryInspector inspectPoolProcessorQuery()
                                                      throws OperationFailedException,
                                                             PermissionDeniedException

Gets a pool processor query inspector for this distributor.

Returns:

the pool processor query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyPoolProcessorSequencing

void applyPoolProcessorSequencing(PoolProcessorSearchOrder poolProcessorSearchOrder)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Applies a pool processor search order to this distributor.

Parameters:

poolProcessorSearchOrder - the pool processor search order

Throws:

NullArgumentException - poolProcessorSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - poolProcessorSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getPoolProcessorQueryFromInspector

PoolProcessorQuery getPoolProcessorQueryFromInspector(PoolProcessorQueryInspector poolProcessorQueryInspector)

Gets a pool processor query from an inspector.

Parameters:

poolProcessorQueryInspector - a pool processor query inspector

Returns:

the pool processor query

Throws:

NullArgumentException - poolProcessorQueryInspector is null

UnsupportedException - poolProcessorQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.