org.osid.provisioning.rules

Interface PoolProcessorEnablerSmartDistributorSession

All Superinterfaces:

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

public interface PoolProcessorEnablerSmartDistributorSession
extends OsidSession

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

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applyPoolProcessorEnablerQuery(PoolProcessorEnablerQuery poolProcessorEnablerQuery) Applies a pool processor enabler query to this distributor.
void	applyPoolProcessorEnablerSequencing(PoolProcessorEnablerSearchOrder poolProcessorEnablerSearchOrder) Applies a pool processor enabler 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.
PoolProcessorEnablerQuery	getPoolProcessorEnablerQuery() Gets a pool processor enabler query.
PoolProcessorEnablerQuery	getPoolProcessorEnablerQueryFromInspector(PoolProcessorEnablerQueryInspector poolProcessorEnablerQueryInspector) Gets a pool processor enabler query from an inspector.
PoolProcessorEnablerSearchOrder	getPoolProcessorEnablerSearchOrder() Gets a pool processor enabler search order.
PoolProcessorEnablerQueryInspector	inspectPoolProcessorEnablerQuery() Gets a pool processor enabler 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.

getPoolProcessorEnablerQuery

PoolProcessorEnablerQuery getPoolProcessorEnablerQuery()

Gets a pool processor enabler query.

Returns:

the pool processor enabler query

Compliance:

mandatory - This method must be implemented.

getPoolProcessorEnablerSearchOrder

PoolProcessorEnablerSearchOrder getPoolProcessorEnablerSearchOrder()

Gets a pool processor enabler search order.

Returns:

the pool processor enabler search order

Compliance:

mandatory - This method must be implemented.

applyPoolProcessorEnablerQuery

void applyPoolProcessorEnablerQuery(PoolProcessorEnablerQuery poolProcessorEnablerQuery)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Applies a pool processor enabler query to this distributor.

Parameters:

poolProcessorEnablerQuery - the pool processor enabler query

Throws:

NullArgumentException - poolProcessorEnablerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - poolProcessorEnablerQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectPoolProcessorEnablerQuery

PoolProcessorEnablerQueryInspector inspectPoolProcessorEnablerQuery()
                                                                    throws OperationFailedException,
                                                                           PermissionDeniedException

Gets a pool processor enabler query inspector for this distributor.

Returns:

the pool processor enabler query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyPoolProcessorEnablerSequencing

void applyPoolProcessorEnablerSequencing(PoolProcessorEnablerSearchOrder poolProcessorEnablerSearchOrder)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Applies a pool processor enabler search order to this distributor.

Parameters:

poolProcessorEnablerSearchOrder - the pool processor enabler search order

Throws:

NullArgumentException - poolProcessorEnablerSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - poolProcessorEnablerSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getPoolProcessorEnablerQueryFromInspector

PoolProcessorEnablerQuery getPoolProcessorEnablerQueryFromInspector(PoolProcessorEnablerQueryInspector poolProcessorEnablerQueryInspector)

Gets a pool processor enabler query from an inspector.

Parameters:

poolProcessorEnablerQueryInspector - a pool processor enabler query inspector

Returns:

the pool processor enabler query

Throws:

NullArgumentException - poolProcessorEnablerQueryInspector is null

UnsupportedException - poolProcessorEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.