org.osid.provisioning.rules

Interface QueueProcessorEnablerDistributorSession

All Superinterfaces:

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

public interface QueueProcessorEnablerDistributorSession
extends OsidSession

This session provides methods to retrieve QueueProcessorEnabler to Distributor mappings. a QueueProcessorEnabler 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	canLookupQueueProcessorEnablerDistributorMappings() Tests if this user can perform lookups of queue processor enabler/distributor mappings.
IdList	getDistributorIdsByQueueProcessorEnabler(Id queueProcessorEnablerId) Gets the Distributor Ids mapped to a QueueProcessorEnabler.
DistributorList	getDistributorsByQueueProcessorEnabler(Id queueProcessorEnablerId) Gets the Distributors mapped to a QueueProcessorEnabler.
IdList	getQueueProcessorEnablerIdsByDistributor(Id distributorId) Gets the list of QueueProcessorEnablerIds associated with a Distributor.
IdList	getQueueProcessorEnablerIdsByDistributors(IdList distributorIds) Gets the list of QueueProcessorEnabler Ids corresponding to a list of Distributors.
QueueProcessorEnablerList	getQueueProcessorEnablersByDistributor(Id distributorId) Gets the list of queue processor enablers associated with a Distributor.
QueueProcessorEnablerList	getQueueProcessorEnablersByDistributors(IdList distributorIds) Gets the list of queue processor enablers corresponding to a list of Distributors.
void	useComparativeQueueProcessorEnablerDistributorView() 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	usePlenaryQueueProcessorEnablerDistributorView() A complete view of the QueueProcessorEnabler 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

canLookupQueueProcessorEnablerDistributorMappings

boolean canLookupQueueProcessorEnablerDistributorMappings()

Tests if this user can perform lookups of queue processor enabler/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.

useComparativeQueueProcessorEnablerDistributorView

void useComparativeQueueProcessorEnablerDistributorView()

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.

usePlenaryQueueProcessorEnablerDistributorView

void usePlenaryQueueProcessorEnablerDistributorView()

A complete view of the QueueProcessorEnabler 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.

getQueueProcessorEnablerIdsByDistributor

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

Gets the list of QueueProcessorEnablerIds associated with a Distributor.

Parameters:

distributorId - Id of the Distributor

Returns:

list of related queue processor enabler 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.

getQueueProcessorEnablersByDistributor

QueueProcessorEnablerList getQueueProcessorEnablersByDistributor(Id distributorId)
                                                                 throws NotFoundException,
                                                                        OperationFailedException,
                                                                        PermissionDeniedException

Gets the list of queue processor enablers associated with a Distributor.

Parameters:

distributorId - Id of the Distributor

Returns:

list of related queue processor enablers

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.

getQueueProcessorEnablerIdsByDistributors

IdList getQueueProcessorEnablerIdsByDistributors(IdList distributorIds)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

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

Parameters:

distributorIds - list of distributor Ids

Returns:

list of queue processor enabler Ids

Throws:

NullArgumentException - distributorIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getQueueProcessorEnablersByDistributors

QueueProcessorEnablerList getQueueProcessorEnablersByDistributors(IdList distributorIds)
                                                                  throws OperationFailedException,
                                                                         PermissionDeniedException

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

Parameters:

distributorIds - list of distributor Ids

Returns:

list of queue processor enablers

Throws:

NullArgumentException - distributorIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDistributorIdsByQueueProcessorEnabler

IdList getDistributorIdsByQueueProcessorEnabler(Id queueProcessorEnablerId)
                                                throws NotFoundException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

Gets the Distributor Ids mapped to a QueueProcessorEnabler.

Parameters:

queueProcessorEnablerId - Id of a QueueProcessorEnabler

Returns:

list of distributors

Throws:

NotFoundException - queueProcessorEnablerId is not found

NullArgumentException - queueProcessorEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDistributorsByQueueProcessorEnabler

DistributorList getDistributorsByQueueProcessorEnabler(Id queueProcessorEnablerId)
                                                       throws NotFoundException,
                                                              OperationFailedException,
                                                              PermissionDeniedException

Gets the Distributors mapped to a QueueProcessorEnabler.

Parameters:

queueProcessorEnablerId - Id of a QueueProcessorEnabler

Returns:

list of distributors

Throws:

NotFoundException - queueProcessorEnablerId is not found

NullArgumentException - queueProcessorEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.