org.osid.provisioning.rules

Interface QueueConstrainerEnablerDistributorAssignmentSession

All Superinterfaces:

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

public interface QueueConstrainerEnablerDistributorAssignmentSession
extends OsidSession

This session provides methods to re-assign QueueConstrainerEnabler to Distributor mappings. a QueueConstrainerEnabler may appear in multiple Distributor objects and removing the last reference to a QueueConstrainerEnabler 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 QueueConstrainerEnabler to another Distributor is not a copy operation (eg: does not change its Id ).

Method Summary

Methods

Modifier and Type	Method and Description
void	assignQueueConstrainerEnablerToDistributor(Id queueConstrainerEnablerId, Id distributorId) Adds an existing QueueConstrainerEnabler to a Distributor.
boolean	canAssignQueueConstrainerEnablers() Tests if this user can alter queue constrainer enabler/distributor mappings.
boolean	canAssignQueueConstrainerEnablersToDistributor(Id distributorId) Tests if this user can alter queue constrainer enabler/distributor mappings.
IdList	getAssignableDistributorIds(Id distributorId) Gets a list of distributors including and under the given distributor node in which any queue constrainer enabler can be assigned.
IdList	getAssignableDistributorIdsForQueueConstrainerEnabler(Id distributorId, Id queueConstrainerEnablerId) Gets a list of distributors including and under the given distributor node in which a specific queue constrainer enabler can be assigned.
void	unassignQueueConstrainerEnablerFromDistributor(Id queueConstrainerEnablerId, Id distributorId) Removes a QueueConstrainerEnabler 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

canAssignQueueConstrainerEnablers

boolean canAssignQueueConstrainerEnablers()

Tests if this user can alter queue constrainer enabler/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.

canAssignQueueConstrainerEnablersToDistributor

boolean canAssignQueueConstrainerEnablersToDistributor(Id distributorId)

Tests if this user can alter queue constrainer enabler/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 enabler 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.

getAssignableDistributorIdsForQueueConstrainerEnabler

IdList getAssignableDistributorIdsForQueueConstrainerEnabler(Id distributorId,
                                                           Id queueConstrainerEnablerId)
                                                             throws OperationFailedException

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

Parameters:

distributorId - the Id of the Distributor

queueConstrainerEnablerId - the Id of the QueueConstrainerEnabler

Returns:

list of assignable distributor Ids

Throws:

NullArgumentException - distributorId or queueConstrainerEnablerId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignQueueConstrainerEnablerToDistributor

void assignQueueConstrainerEnablerToDistributor(Id queueConstrainerEnablerId,
                                              Id distributorId)
                                                throws AlreadyExistsException,
                                                       NotFoundException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

Adds an existing QueueConstrainerEnabler to a Distributor.

Parameters:

queueConstrainerEnablerId - the Id of the QueueConstrainerEnabler

distributorId - the Id of the Distributor

Throws:

AlreadyExistsException - queueConstrainerEnablerId is already assigned to distributorId

NotFoundException - queueConstrainerEnablerId or distributorId not found

NullArgumentException - queueConstrainerEnablerId or distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignQueueConstrainerEnablerFromDistributor

void unassignQueueConstrainerEnablerFromDistributor(Id queueConstrainerEnablerId,
                                                  Id distributorId)
                                                    throws NotFoundException,
                                                           OperationFailedException,
                                                           PermissionDeniedException

Removes a QueueConstrainerEnabler from a Distributor.

Parameters:

queueConstrainerEnablerId - the Id of the QueueConstrainerEnabler

distributorId - the Id of the Distributor

Throws:

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

NullArgumentException - queueConstrainerEnablerId or distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.