org.osid.provisioning.rules

Interface QueueConstrainerEnablerDistributorSession

All Superinterfaces:

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

public interface QueueConstrainerEnablerDistributorSession
extends OsidSession

This session provides methods to retrieve QueueConstrainerEnabler to Distributor mappings. a QueueConstrainerEnabler 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	canLookupQueueConstrainerEnablerDistributorMappings() Tests if this user can perform lookups of queue constrainer enabler/distributor mappings.
IdList	getDistributorIdsByQueueConstrainerEnabler(Id queueConstrainerEnablerId) Gets the Distributor Ids mapped to a QueueConstrainerEnabler.
DistributorList	getDistributorsByQueueConstrainerEnabler(Id queueConstrainerEnablerId) Gets the Distributors mapped to a QueueConstrainerEnabler.
IdList	getQueueConstrainerEnablerIdsByDistributor(Id distributorId) Gets the list of QueueConstrainerEnablerIds associated with a Distributor.
IdList	getQueueConstrainerEnablerIdsByDistributors(IdList distributorIds) Gets the list of QueueConstrainerEnabler Ids corresponding to a list of Distributors.
QueueConstrainerEnablerList	getQueueConstrainerEnablersByDistributor(Id distributorId) Gets the list of queue constrainer enablers associated with a Distributor.
QueueConstrainerEnablerList	getQueueConstrainerEnablersByDistributors(IdList distributorIds) Gets the list of queue constrainer enablers corresponding to a list of Distributors.
void	useComparativeQueueConstrainerEnablerDistributorView() 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	usePlenaryQueueConstrainerEnablerDistributorView() A complete view of the QueueConstrainerEnabler 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

canLookupQueueConstrainerEnablerDistributorMappings

boolean canLookupQueueConstrainerEnablerDistributorMappings()

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

useComparativeQueueConstrainerEnablerDistributorView

void useComparativeQueueConstrainerEnablerDistributorView()

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.

usePlenaryQueueConstrainerEnablerDistributorView

void usePlenaryQueueConstrainerEnablerDistributorView()

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

getQueueConstrainerEnablerIdsByDistributor

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

Gets the list of QueueConstrainerEnablerIds associated with a Distributor.

Parameters:

distributorId - Id of the Distributor

Returns:

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

getQueueConstrainerEnablersByDistributor

QueueConstrainerEnablerList getQueueConstrainerEnablersByDistributor(Id distributorId)
                                                                     throws NotFoundException,
                                                                            OperationFailedException,
                                                                            PermissionDeniedException

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

Parameters:

distributorId - Id of the Distributor

Returns:

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

getQueueConstrainerEnablerIdsByDistributors

IdList getQueueConstrainerEnablerIdsByDistributors(IdList distributorIds)
                                                   throws OperationFailedException,
                                                          PermissionDeniedException

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

Parameters:

distributorIds - list of distributor Ids

Returns:

list of queue constrainer enabler Ids

Throws:

NullArgumentException - distributorIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getQueueConstrainerEnablersByDistributors

QueueConstrainerEnablerList getQueueConstrainerEnablersByDistributors(IdList distributorIds)
                                                                      throws OperationFailedException,
                                                                             PermissionDeniedException

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

Parameters:

distributorIds - list of distributor Ids

Returns:

list of queue constrainer enablers

Throws:

NullArgumentException - distributorIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDistributorIdsByQueueConstrainerEnabler

IdList getDistributorIdsByQueueConstrainerEnabler(Id queueConstrainerEnablerId)
                                                  throws NotFoundException,
                                                         OperationFailedException,
                                                         PermissionDeniedException

Gets the Distributor Ids mapped to a QueueConstrainerEnabler.

Parameters:

queueConstrainerEnablerId - Id of a QueueConstrainerEnabler

Returns:

list of distributors

Throws:

NotFoundException - queueConstrainerEnablerId is not found

NullArgumentException - queueConstrainerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDistributorsByQueueConstrainerEnabler

DistributorList getDistributorsByQueueConstrainerEnabler(Id queueConstrainerEnablerId)
                                                         throws NotFoundException,
                                                                OperationFailedException,
                                                                PermissionDeniedException

Gets the Distributors mapped to a QueueConstrainerEnabler.

Parameters:

queueConstrainerEnablerId - Id of a QueueConstrainerEnabler

Returns:

list of distributors

Throws:

NotFoundException - queueConstrainerEnablerId is not found

NullArgumentException - queueConstrainerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.