org.osid.provisioning

Interface ProvisionableSmartDistributorSession

All Superinterfaces:

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

public interface ProvisionableSmartDistributorSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A ProvisionableQuery can be retrieved from this session and distributorped to this Distributor to create a virtual collection of Provisionables. The provisionables may be sequenced using the ProvisionableSearchOrder from this session.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applyProvisionableQuery(ProvisionableQuery provisionableQuery) Applies a provisionable query to this distributor.
void	applyProvisionableSequencing(ProvisionableSearchOrder provisionableSearchOrder) Applies a provisionable 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.
ProvisionableQuery	getProvisionableQuery() Gets a provisionable query.
ProvisionableQuery	getProvisionableQueryFromInspector(ProvisionableQueryInspector provisionableQueryInspector) Gets a provisionable query from an inspector.
ProvisionableSearchOrder	getProvisionableSearchOrder() Gets a provisionable search order.
ProvisionableQueryInspector	inspectProvisionableQuery() Gets a provisionable 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.

getProvisionableQuery

ProvisionableQuery getProvisionableQuery()

Gets a provisionable query.

Returns:

the provisionable query

Compliance:

mandatory - This method must be implemented.

getProvisionableSearchOrder

ProvisionableSearchOrder getProvisionableSearchOrder()

Gets a provisionable search order.

Returns:

the provisionable search order

Compliance:

mandatory - This method must be implemented.

applyProvisionableQuery

void applyProvisionableQuery(ProvisionableQuery provisionableQuery)
                             throws OperationFailedException,
                                    PermissionDeniedException

Applies a provisionable query to this distributor.

Parameters:

provisionableQuery - the provisionable query

Throws:

NullArgumentException - provisionableQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - provisionableQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectProvisionableQuery

ProvisionableQueryInspector inspectProvisionableQuery()
                                                      throws OperationFailedException,
                                                             PermissionDeniedException

Gets a provisionable query inspector for this distributor.

Returns:

the provisionable query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyProvisionableSequencing

void applyProvisionableSequencing(ProvisionableSearchOrder provisionableSearchOrder)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Applies a provisionable search order to this distributor.

Parameters:

provisionableSearchOrder - the provisionable search order

Throws:

NullArgumentException - provisionableSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - provisionableSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getProvisionableQueryFromInspector

ProvisionableQuery getProvisionableQueryFromInspector(ProvisionableQueryInspector provisionableQueryInspector)

Gets a provisionable query from an inspector.

Parameters:

provisionableQueryInspector - a provisionable query inspector

Returns:

the provisionable query

Throws:

NullArgumentException - provisionableQueryInspector is null

UnsupportedException - provisionableQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.