org.osid.provisioning.rules

Interface PoolConstrainerEnablerSmartDistributorSession

All Superinterfaces:

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

public interface PoolConstrainerEnablerSmartDistributorSession
extends OsidSession

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

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applyPoolConstrainerEnablerQuery(PoolConstrainerEnablerQuery poolConstrainerEnablerQuery) Applies a pool constrainer enabler query to this distributor.
void	applyPoolConstrainerEnablerSequencing(PoolConstrainerEnablerSearchOrder poolConstrainerEnablerSearchOrder) Applies a pool constrainer 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.
PoolConstrainerEnablerQuery	getPoolConstrainerEnablerQuery() Gets a pool constrainer enabler query.
PoolConstrainerEnablerQuery	getPoolConstrainerEnablerQueryFromInspector(PoolConstrainerEnablerQueryInspector poolConstrainerEnablerQueryInspector) Gets a pool constrainer enabler query from an inspector.
PoolConstrainerEnablerSearchOrder	getPoolConstrainerEnablerSearchOrder() Gets a pool constrainer enabler search order.
PoolConstrainerEnablerQueryInspector	inspectPoolConstrainerEnablerQuery() Gets a pool constrainer 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.

getPoolConstrainerEnablerQuery

PoolConstrainerEnablerQuery getPoolConstrainerEnablerQuery()

Gets a pool constrainer enabler query.

Returns:

the pool constrainer enabler query

Compliance:

mandatory - This method must be implemented.

getPoolConstrainerEnablerSearchOrder

PoolConstrainerEnablerSearchOrder getPoolConstrainerEnablerSearchOrder()

Gets a pool constrainer enabler search order.

Returns:

the pool constrainer enabler search order

Compliance:

mandatory - This method must be implemented.

applyPoolConstrainerEnablerQuery

void applyPoolConstrainerEnablerQuery(PoolConstrainerEnablerQuery poolConstrainerEnablerQuery)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Applies a pool constrainer enabler query to this distributor.

Parameters:

poolConstrainerEnablerQuery - the pool constrainer enabler query

Throws:

NullArgumentException - poolConstrainerEnablerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - poolConstrainerEnablerQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectPoolConstrainerEnablerQuery

PoolConstrainerEnablerQueryInspector inspectPoolConstrainerEnablerQuery()
                                                                        throws OperationFailedException,
                                                                               PermissionDeniedException

Gets a pool constrainer enabler query inspector for this distributor.

Returns:

the pool constrainer enabler query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyPoolConstrainerEnablerSequencing

void applyPoolConstrainerEnablerSequencing(PoolConstrainerEnablerSearchOrder poolConstrainerEnablerSearchOrder)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Applies a pool constrainer enabler search order to this distributor.

Parameters:

poolConstrainerEnablerSearchOrder - the pool constrainer enabler search order

Throws:

NullArgumentException - poolConstrainerEnablerSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - poolConstrainerEnablerSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getPoolConstrainerEnablerQueryFromInspector

PoolConstrainerEnablerQuery getPoolConstrainerEnablerQueryFromInspector(PoolConstrainerEnablerQueryInspector poolConstrainerEnablerQueryInspector)

Gets a pool constrainer enabler query from an inspector.

Parameters:

poolConstrainerEnablerQueryInspector - a pool constrainer enabler query inspector

Returns:

the pool constrainer enabler query

Throws:

NullArgumentException - poolConstrainerEnablerQueryInspector is null

UnsupportedException - poolConstrainerEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.