org.osid.provisioning.rules

Interface QueueConstrainerDistributorSession

All Superinterfaces:

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

public interface QueueConstrainerDistributorSession
extends OsidSession

This session provides methods to retrieve QueueConstrainer to Distributor mappings. a QueueConstrainer 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	canLookupQueueConstrainerDistributorMappings() Tests if this user can perform lookups of queue constrainer/distributor mappings.
IdList	getDistributorIdsByQueueConstrainer(Id queueConstrainerId) Gets the Distributor Ids mapped to a QueueConstrainer.
DistributorList	getDistributorsByQueueConstrainer(Id queueConstrainerId) Gets the Distributors mapped to a QueueConstrainer.
IdList	getQueueConstrainerIdsByDistributor(Id distributorId) Gets the list of QueueConstrainerIds associated with a Distributor.
IdList	getQueueConstrainerIdsByDistributors(IdList distributorIds) Gets the list of QueueConstrainer Ids corresponding to a list of Distributors.
QueueConstrainerList	getQueueConstrainersByDistributor(Id distributorId) Gets the list of queue constrainer associated with a Distributor.
QueueConstrainerList	getQueueConstrainersByDistributors(IdList distributorIds) Gets the list of queue constrainer corresponding to a list of Distributors.
void	useComparativeQueueConstrainerDistributorView() 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	usePlenaryQueueConstrainerDistributorView() A complete view of the QueueConstrainer 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

canLookupQueueConstrainerDistributorMappings

boolean canLookupQueueConstrainerDistributorMappings()

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

useComparativeQueueConstrainerDistributorView

void useComparativeQueueConstrainerDistributorView()

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.

usePlenaryQueueConstrainerDistributorView

void usePlenaryQueueConstrainerDistributorView()

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

getQueueConstrainerIdsByDistributor

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

Gets the list of QueueConstrainerIds associated with a Distributor.

Parameters:

distributorId - Id of the Distributor

Returns:

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

getQueueConstrainersByDistributor

QueueConstrainerList getQueueConstrainersByDistributor(Id distributorId)
                                                       throws NotFoundException,
                                                              OperationFailedException,
                                                              PermissionDeniedException

Gets the list of queue constrainer associated with a Distributor.

Parameters:

distributorId - Id of the Distributor

Returns:

list of related queue constrainers

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.

getQueueConstrainerIdsByDistributors

IdList getQueueConstrainerIdsByDistributors(IdList distributorIds)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

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

Parameters:

distributorIds - list of distributor Ids

Returns:

list of queue constrainer Ids

Throws:

NullArgumentException - distributorIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getQueueConstrainersByDistributors

QueueConstrainerList getQueueConstrainersByDistributors(IdList distributorIds)
                                                        throws OperationFailedException,
                                                               PermissionDeniedException

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

Parameters:

distributorIds - list of distributor Ids

Returns:

list of queue constrainers

Throws:

NullArgumentException - distributorIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDistributorIdsByQueueConstrainer

IdList getDistributorIdsByQueueConstrainer(Id queueConstrainerId)
                                           throws NotFoundException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

Gets the Distributor Ids mapped to a QueueConstrainer.

Parameters:

queueConstrainerId - Id of a QueueConstrainer

Returns:

list of distributors

Throws:

NotFoundException - queueConstrainerId is not found

NullArgumentException - queueConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDistributorsByQueueConstrainer

DistributorList getDistributorsByQueueConstrainer(Id queueConstrainerId)
                                                  throws NotFoundException,
                                                         OperationFailedException,
                                                         PermissionDeniedException

Gets the Distributors mapped to a QueueConstrainer.

Parameters:

queueConstrainerId - Id of a QueueConstrainer

Returns:

list of distributors

Throws:

NotFoundException - queueConstrainerId is not found

NullArgumentException - queueConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.