org.osid.provisioning

Interface QueueSmartDistributorSession

All Superinterfaces:

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

public interface QueueSmartDistributorSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A QueueQuery can be retrieved from this session and mapped to this Distributor to create a virtual collection of queues. The queues may be sequenced using the QueueSearchOrder from this session.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applyQueueQuery(QueueQuery queueQuery) Applies a queue query to this distributor.
void	applyQueueSequencing(QueueSearchOrder queueSearchOrder) Applies a queue 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.
QueueQuery	getQueueQuery() Gets a queue query.
QueueQuery	getQueueQueryFromInspector(QueueQueryInspector queueQueryInspector) Gets a queue query from an inspector.
QueueSearchOrder	getQueueSearchOrder() Gets a queue search order.
QueueQueryInspector	inspecQueueQuery() Gets a queue 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.

getQueueQuery

QueueQuery getQueueQuery()

Gets a queue query.

Returns:

the queue query

Compliance:

mandatory - This method must be implemented.

getQueueSearchOrder

QueueSearchOrder getQueueSearchOrder()

Gets a queue search order.

Returns:

the queue search order

Compliance:

mandatory - This method must be implemented.

applyQueueQuery

void applyQueueQuery(QueueQuery queueQuery)
                     throws OperationFailedException,
                            PermissionDeniedException

Applies a queue query to this distributor.

Parameters:

queueQuery - the queue query

Throws:

NullArgumentException - queueQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - queueQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspecQueueQuery

QueueQueryInspector inspecQueueQuery()
                                     throws OperationFailedException,
                                            PermissionDeniedException

Gets a queue query inspector for this distributor.

Returns:

the queue query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyQueueSequencing

void applyQueueSequencing(QueueSearchOrder queueSearchOrder)
                          throws OperationFailedException,
                                 PermissionDeniedException

Applies a queue search order to this distributor.

Parameters:

queueSearchOrder - the queue search order

Throws:

NullArgumentException - queueSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - queueSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getQueueQueryFromInspector

QueueQuery getQueueQueryFromInspector(QueueQueryInspector queueQueryInspector)

Gets a queue query from an inspector.

Parameters:

queueQueryInspector - a queue query inspector

Returns:

the queue query

Throws:

NullArgumentException - queueQueryInspector is null

UnsupportedException - queueQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.