org.osid.provisioning

Interface PoolSmartDistributorSession

All Superinterfaces:

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

public interface PoolSmartDistributorSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A PoolQuery can be retrieved from this session and distributorped to this Distributor to create a virtual collection of Pools. The pools may be sequenced using the PoolSearchOrder from this session.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applyPoolQuery(PoolQuery poolQuery) Applies a pool query to this distributor.
void	applyPoolSequencing(PoolSearchOrder poolSearchOrder) Applies a pool 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.
PoolQuery	getPoolQuery() Gets a pool query.
PoolQuery	getPoolQueryFromInspector(PoolQueryInspector poolQueryInspector) Gets a pool query from an inspector.
PoolSearchOrder	getPoolSearchOrder() Gets a pool search order.
PoolQueryInspector	inspectPoolQuery() Gets a pool 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.

getPoolQuery

PoolQuery getPoolQuery()

Gets a pool query.

Returns:

the pool query

Compliance:

mandatory - This method must be implemented.

getPoolSearchOrder

PoolSearchOrder getPoolSearchOrder()

Gets a pool search order.

Returns:

the pool search order

Compliance:

mandatory - This method must be implemented.

applyPoolQuery

void applyPoolQuery(PoolQuery poolQuery)
                    throws OperationFailedException,
                           PermissionDeniedException

Applies a pool query to this distributor.

Parameters:

poolQuery - the pool query

Throws:

NullArgumentException - poolQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - poolQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectPoolQuery

PoolQueryInspector inspectPoolQuery()
                                    throws OperationFailedException,
                                           PermissionDeniedException

Gets a pool query inspector for this distributor.

Returns:

the pool query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyPoolSequencing

void applyPoolSequencing(PoolSearchOrder poolSearchOrder)
                         throws OperationFailedException,
                                PermissionDeniedException

Applies a pool search order to this distributor.

Parameters:

poolSearchOrder - the pool search order

Throws:

NullArgumentException - poolSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - poolSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getPoolQueryFromInspector

PoolQuery getPoolQueryFromInspector(PoolQueryInspector poolQueryInspector)

Gets a pool query from an inspector.

Parameters:

poolQueryInspector - a pool query inspector

Returns:

the pool query

Throws:

NullArgumentException - poolQueryInspector is null

UnsupportedException - poolQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.