org.osid.provisioning.rules

Interface QueueConstrainerDistributorAssignmentSession

All Superinterfaces:

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

public interface QueueConstrainerDistributorAssignmentSession
extends OsidSession

This session provides methods to re-assign QueueConstrainer to Distributor mappings. a QueueConstrainer may appear in multiple Distributor objects and removing the last reference to a QueueConstrainer is the equivalent of deleting it. Each Distributor may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a QueueConstrainer to another Distributor is not a copy operation (eg: does not change its Id ).

Method Summary

Methods

Modifier and Type	Method and Description
void	assignQueueConstrainerToDistributor(Id queueConstrainerId, Id distributorId) Adds an existing QueueConstrainer to a Distributor.
boolean	canAssignQueueConstrainers() Tests if this user can alter queue constrainer/distributor mappings.
boolean	canAssignQueueConstrainersToDistributor(Id distributorId) Tests if this user can alter queue constrainer/distributor mappings.
IdList	getAssignableDistributorIds(Id distributorId) Gets a list of distributors including and under the given distributor node in which any queue constrainer can be assigned.
IdList	getAssignableDistributorIdsForQueueConstrainer(Id distributorId, Id queueConstrainerId) Gets a list of distributors including and under the given distributor node in which a specific queue constrainer can be assigned.
void	unassignQueueConstrainerFromDistributor(Id queueConstrainerId, Id distributorId) Removes a QueueConstrainer from a 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

canAssignQueueConstrainers

boolean canAssignQueueConstrainers()

Tests if this user can alter queue constrainer/distributor mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canAssignQueueConstrainersToDistributor

boolean canAssignQueueConstrainersToDistributor(Id distributorId)

Tests if this user can alter queue constrainer/distributor mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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.

Parameters:

distributorId - the Id of the Distributor

Returns:

false if mapping is not authorized, true otherwise

Throws:

NullArgumentException - distributorId is null

Compliance:

mandatory - This method must be implemented.

getAssignableDistributorIds

IdList getAssignableDistributorIds(Id distributorId)
                                   throws OperationFailedException

Gets a list of distributors including and under the given distributor node in which any queue constrainer can be assigned.

Parameters:

distributorId - the Id of the Distributor

Returns:

list of assignable distributor Ids

Throws:

NullArgumentException - distributorId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getAssignableDistributorIdsForQueueConstrainer

IdList getAssignableDistributorIdsForQueueConstrainer(Id distributorId,
                                                    Id queueConstrainerId)
                                                      throws OperationFailedException

Gets a list of distributors including and under the given distributor node in which a specific queue constrainer can be assigned.

Parameters:

distributorId - the Id of the Distributor

queueConstrainerId - the Id of the QueueConstrainer

Returns:

list of assignable distributor Ids

Throws:

NullArgumentException - distributorId or queueConstrainerId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignQueueConstrainerToDistributor

void assignQueueConstrainerToDistributor(Id queueConstrainerId,
                                       Id distributorId)
                                         throws AlreadyExistsException,
                                                NotFoundException,
                                                OperationFailedException,
                                                PermissionDeniedException

Adds an existing QueueConstrainer to a Distributor.

Parameters:

queueConstrainerId - the Id of the QueueConstrainer

distributorId - the Id of the Distributor

Throws:

AlreadyExistsException - queueConstrainerId is not assigned to distributorId

NotFoundException - queueConstrainerId or distributorId not found

NullArgumentException - queueConstrainerId or distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignQueueConstrainerFromDistributor

void unassignQueueConstrainerFromDistributor(Id queueConstrainerId,
                                           Id distributorId)
                                             throws NotFoundException,
                                                    OperationFailedException,
                                                    PermissionDeniedException

Removes a QueueConstrainer from a Distributor.

Parameters:

queueConstrainerId - the Id of the QueueConstrainer

distributorId - the Id of the Distributor

Throws:

NotFoundException - queueConstrainerId or distributorId not found or queueConstrainerId not assigned to distributorId

NullArgumentException - queueConstrainerId or distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.