org.osid.provisioning.rules

Interface PoolConstrainerSmartDistributorSession

All Superinterfaces:

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

public interface PoolConstrainerSmartDistributorSession
extends OsidSession

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

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applyPoolConstrainerQuery(PoolConstrainerQuery poolConstrainerQuery) Applies a pool constrainer query to this distributor.
void	applyPoolConstrainerSequencing(PoolConstrainerSearchOrder poolConstrainerSearchOrder) Applies a pool constrainer 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.
PoolConstrainerQuery	getPoolConstrainerQuery() Gets a pool constrainer query.
PoolConstrainerQuery	getPoolConstrainerQueryFromInspector(PoolConstrainerQueryInspector poolConstrainerQueryInspector) Gets a pool constrainer query from an inspector.
PoolConstrainerSearchOrder	getPoolConstrainerSearchOrder() Gets a pool constrainer search order.
PoolConstrainerQueryInspector	inspectPoolConstrainerQuery() Gets a pool 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.

getPoolConstrainerQuery

PoolConstrainerQuery getPoolConstrainerQuery()

Gets a pool constrainer query.

Returns:

the pool constrainer query

Compliance:

mandatory - This method must be implemented.

getPoolConstrainerSearchOrder

PoolConstrainerSearchOrder getPoolConstrainerSearchOrder()

Gets a pool constrainer search order.

Returns:

the pool constrainer search order

Compliance:

mandatory - This method must be implemented.

applyPoolConstrainerQuery

void applyPoolConstrainerQuery(PoolConstrainerQuery poolConstrainerQuery)
                               throws OperationFailedException,
                                      PermissionDeniedException

Applies a pool constrainer query to this distributor.

Parameters:

poolConstrainerQuery - the pool constrainer query

Throws:

NullArgumentException - poolConstrainerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - poolConstrainerQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectPoolConstrainerQuery

PoolConstrainerQueryInspector inspectPoolConstrainerQuery()
                                                          throws OperationFailedException,
                                                                 PermissionDeniedException

Gets a pool constrainer query inspector for this distributor.

Returns:

the pool constrainer query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyPoolConstrainerSequencing

void applyPoolConstrainerSequencing(PoolConstrainerSearchOrder poolConstrainerSearchOrder)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Applies a pool constrainer search order to this distributor.

Parameters:

poolConstrainerSearchOrder - the pool constrainer search order

Throws:

NullArgumentException - poolConstrainerSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - poolConstrainerSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getPoolConstrainerQueryFromInspector

PoolConstrainerQuery getPoolConstrainerQueryFromInspector(PoolConstrainerQueryInspector poolConstrainerQueryInspector)

Gets a pool constrainer query from an inspector.

Parameters:

poolConstrainerQueryInspector - a pool constrainer query inspector

Returns:

the pool constrainer query

Throws:

NullArgumentException - poolConstrainerQueryInspector is null

UnsupportedException - poolConstrainerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.