org.osid.provisioning.rules

Interface QueueProcessorDistributorSession

All Superinterfaces:

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

public interface QueueProcessorDistributorSession
extends OsidSession

This session provides methods to retrieve QueueProcessor to Distributor mappings. a QueueProcessor may appear in multiple Distributor objects. Each distributor may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupQueueProcessorDistributorMappings() Tests if this user can perform lookups of queue processor/distributor mappings.
IdList	getDistributorIdsByQueueProcessor(Id queueProcessorId) Gets the Distributor Ids mapped to a QueueProcessor.
DistributorList	getDistributorsByQueueProcessor(Id queueProcessorId) Gets the Distributors mapped to a QueueProcessor.
IdList	getQueueProcessorIdsByDistributor(Id distributorId) Gets the list of QueueProcessorIds associated with a Distributor.
IdList	getQueueProcessorIdsByDistributors(IdList distributorIds) Gets the list of QueueProcessor Ids corresponding to a list of Distributors.
QueueProcessorList	getQueueProcessorsByDistributor(Id distributorId) Gets the list of queue processors associated with a Distributor.
QueueProcessorList	getQueueProcessorsByDistributors(IdList distributorIds) Gets the list of queue processor corresponding to a list of Distributors.
void	useComparativeQueueProcessorDistributorView() The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryQueueProcessorDistributorView() A complete view of the QueueProcessor and Distributor returns is desired.

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

canLookupQueueProcessorDistributorMappings

boolean canLookupQueueProcessorDistributorMappings()

Tests if this user can perform lookups of queue processor/distributor mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeQueueProcessorDistributorView

void useComparativeQueueProcessorDistributorView()

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryQueueProcessorDistributorView

void usePlenaryQueueProcessorDistributorView()

A complete view of the QueueProcessor and Distributor returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

getQueueProcessorIdsByDistributor

IdList getQueueProcessorIdsByDistributor(Id distributorId)
                                         throws NotFoundException,
                                                OperationFailedException,
                                                PermissionDeniedException

Gets the list of QueueProcessorIds associated with a Distributor.

Parameters:

distributorId - Id of the Distributor

Returns:

list of related queue processor Ids

Throws:

NotFoundException - distributorId is not found

NullArgumentException - distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getQueueProcessorsByDistributor

QueueProcessorList getQueueProcessorsByDistributor(Id distributorId)
                                                   throws NotFoundException,
                                                          OperationFailedException,
                                                          PermissionDeniedException

Gets the list of queue processors associated with a Distributor.

Parameters:

distributorId - Id of the Distributor

Returns:

list of related queue processors

Throws:

NotFoundException - distributorId is not found

NullArgumentException - distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getQueueProcessorIdsByDistributors

IdList getQueueProcessorIdsByDistributors(IdList distributorIds)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Gets the list of QueueProcessor Ids corresponding to a list of Distributors.

Parameters:

distributorIds - list of distributor Ids

Returns:

list of queue processor Ids

Throws:

NullArgumentException - distributorIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getQueueProcessorsByDistributors

QueueProcessorList getQueueProcessorsByDistributors(IdList distributorIds)
                                                    throws OperationFailedException,
                                                           PermissionDeniedException

Gets the list of queue processor corresponding to a list of Distributors.

Parameters:

distributorIds - list of distributor Ids

Returns:

list of queue processors

Throws:

NullArgumentException - distributorIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDistributorIdsByQueueProcessor

IdList getDistributorIdsByQueueProcessor(Id queueProcessorId)
                                         throws NotFoundException,
                                                OperationFailedException,
                                                PermissionDeniedException

Gets the Distributor Ids mapped to a QueueProcessor.

Parameters:

queueProcessorId - Id of a QueueProcessor

Returns:

list of distributors

Throws:

NotFoundException - queueProcessorId is not found

NullArgumentException - queueProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDistributorsByQueueProcessor

DistributorList getDistributorsByQueueProcessor(Id queueProcessorId)
                                                throws NotFoundException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

Gets the Distributors mapped to a QueueProcessor.

Parameters:

queueProcessorId - Id of a QueueProcessor

Returns:

list of distributors

Throws:

NotFoundException - queueProcessorId is not found

NullArgumentException - queueProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.