org.osid.provisioning.rules

Interface QueueProcessorSmartDistributorSession

All Superinterfaces:

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

public interface QueueProcessorSmartDistributorSession
extends OsidSession

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

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applyQueueProcessorQuery(QueueProcessorQuery queueProcessorQuery) Applies a queue processor query to this distributor.
void	applyQueueProcessorSequencing(QueueProcessorSearchOrder queueProcessorSearchOrder) Applies a queue processor 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.
QueueProcessorQuery	getQueueProcessorQuery() Gets a queue processor query.
QueueProcessorQuery	getQueueProcessorQueryFromInspector(QueueProcessorQueryInspector queueProcessorQueryInspector) Gets a queue processor query from an inspector.
QueueProcessorSearchOrder	getQueueProcessorSearchOrder() Gets a queue processor search order.
QueueProcessorQueryInspector	inspectQueueProcessorQuery() Gets a queue processor 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.

getQueueProcessorQuery

QueueProcessorQuery getQueueProcessorQuery()

Gets a queue processor query.

Returns:

the queue processor query

Compliance:

mandatory - This method must be implemented.

getQueueProcessorSearchOrder

QueueProcessorSearchOrder getQueueProcessorSearchOrder()

Gets a queue processor search order.

Returns:

the queue processor search order

Compliance:

mandatory - This method must be implemented.

applyQueueProcessorQuery

void applyQueueProcessorQuery(QueueProcessorQuery queueProcessorQuery)
                              throws OperationFailedException,
                                     PermissionDeniedException

Applies a queue processor query to this distributor.

Parameters:

queueProcessorQuery - the queue processor query

Throws:

NullArgumentException - queueProcessorQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - queueProcessorQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectQueueProcessorQuery

QueueProcessorQueryInspector inspectQueueProcessorQuery()
                                                        throws OperationFailedException,
                                                               PermissionDeniedException

Gets a queue processor query inspector for this distributor.

Returns:

the queue processor query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyQueueProcessorSequencing

void applyQueueProcessorSequencing(QueueProcessorSearchOrder queueProcessorSearchOrder)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Applies a queue processor search order to this distributor.

Parameters:

queueProcessorSearchOrder - the queue processor search order

Throws:

NullArgumentException - queueProcessorSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - queueProcessorSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getQueueProcessorQueryFromInspector

QueueProcessorQuery getQueueProcessorQueryFromInspector(QueueProcessorQueryInspector queueProcessorQueryInspector)

Gets a queue processor query from an inspector.

Parameters:

queueProcessorQueryInspector - a queue processor query inspector

Returns:

the queue processor query

Throws:

NullArgumentException - queueProcessorQueryInspector is null

UnsupportedException - queueProcessorQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.