org.osid.provisioning.rules

Interface QueueProcessorEnablerSmartDistributorSession

All Superinterfaces:

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

public interface QueueProcessorEnablerSmartDistributorSession
extends OsidSession

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

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applyQueueProcessorEnablerQuery(QueueProcessorEnablerQuery queueProcessorEnablerQuery) Applies a queue processor enabler query to this distributor.
void	applyQueueProcessorEnablerSequencing(QueueProcessorEnablerSearchOrder queueProcessorEnablerSearchOrder) Applies a queue 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.
QueueProcessorEnablerQuery	getQueueProcessorEnablerQuery() Gets a queue processor enabler query.
QueueProcessorEnablerQuery	getQueueProcessorEnablerQueryFromInspector(QueueProcessorEnablerQueryInspector queueProcessorEnablerQueryInspector) Gets a queue processor enabler query from an inspector.
QueueProcessorEnablerSearchOrder	getQueueProcessorEnablerSearchOrder() Gets a queue processor enabler search order.
QueueProcessorEnablerQueryInspector	inspectQueueProcessorEnablerQuery() Gets a queue 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.

getQueueProcessorEnablerQuery

QueueProcessorEnablerQuery getQueueProcessorEnablerQuery()

Gets a queue processor enabler query.

Returns:

the queue processor enabler query

Compliance:

mandatory - This method must be implemented.

getQueueProcessorEnablerSearchOrder

QueueProcessorEnablerSearchOrder getQueueProcessorEnablerSearchOrder()

Gets a queue processor enabler search order.

Returns:

the queue processor enabler search order

Compliance:

mandatory - This method must be implemented.

applyQueueProcessorEnablerQuery

void applyQueueProcessorEnablerQuery(QueueProcessorEnablerQuery queueProcessorEnablerQuery)
                                     throws OperationFailedException,
                                            PermissionDeniedException

Applies a queue processor enabler query to this distributor.

Parameters:

queueProcessorEnablerQuery - the queue processor enabler query

Throws:

NullArgumentException - queueProcessorEnablerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - queueProcessorEnablerQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectQueueProcessorEnablerQuery

QueueProcessorEnablerQueryInspector inspectQueueProcessorEnablerQuery()
                                                                      throws OperationFailedException,
                                                                             PermissionDeniedException

Gets a queue processor enabler query inspector for this distributor.

Returns:

the queue processor enabler query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyQueueProcessorEnablerSequencing

void applyQueueProcessorEnablerSequencing(QueueProcessorEnablerSearchOrder queueProcessorEnablerSearchOrder)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Applies a queue processor enabler search order to this distributor.

Parameters:

queueProcessorEnablerSearchOrder - the queue processor enabler search order

Throws:

NullArgumentException - queueProcessorEnablerSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - queueProcessorEnablerSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getQueueProcessorEnablerQueryFromInspector

QueueProcessorEnablerQuery getQueueProcessorEnablerQueryFromInspector(QueueProcessorEnablerQueryInspector queueProcessorEnablerQueryInspector)

Gets a queue processor enabler query from an inspector.

Parameters:

queueProcessorEnablerQueryInspector - a queue processor enabler query inspector

Returns:

the queue processor enabler query

Throws:

NullArgumentException - queueProcessorEnablerQueryInspector is null

UnsupportedException - queueProcessorEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.