org.osid.provisioning.rules

Interface PoolProcessorDistributorAssignmentSession

All Superinterfaces:

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

public interface PoolProcessorDistributorAssignmentSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
void	assignPoolProcessorToDistributor(Id poolProcessorId, Id distributorId) Adds an existing PoolProcessor to a Distributor.
boolean	canAssignPoolProcessors() Tests if this user can alter pool processor/distributor mappings.
boolean	canAssignPoolProcessorsToDistributor(Id distributorId) Tests if this user can alter pool processor/distributor mappings.
IdList	getAssignableDistributorIds(Id distributorId) Gets a list of distributors including and under the given distributor node in which any pool processor can be assigned.
IdList	getAssignableDistributorIdsForPoolProcessor(Id distributorId, Id poolProcessorId) Gets a list of distributors including and under the given distributor node in which a specific pool processor can be assigned.
void	unassignPoolProcessorFromDistributor(Id poolProcessorId, Id distributorId) Removes a PoolProcessor 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

canAssignPoolProcessors

boolean canAssignPoolProcessors()

Tests if this user can alter pool processor/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.

canAssignPoolProcessorsToDistributor

boolean canAssignPoolProcessorsToDistributor(Id distributorId)

Tests if this user can alter pool processor/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 pool processor 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.

getAssignableDistributorIdsForPoolProcessor

IdList getAssignableDistributorIdsForPoolProcessor(Id distributorId,
                                                 Id poolProcessorId)
                                                   throws OperationFailedException

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

Parameters:

distributorId - the Id of the Distributor

poolProcessorId - the Id of the PoolProcessor

Returns:

list of assignable distributor Ids

Throws:

NullArgumentException - distributorId or poolProcessorId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignPoolProcessorToDistributor

void assignPoolProcessorToDistributor(Id poolProcessorId,
                                    Id distributorId)
                                      throws AlreadyExistsException,
                                             NotFoundException,
                                             OperationFailedException,
                                             PermissionDeniedException

Adds an existing PoolProcessor to a Distributor.

Parameters:

poolProcessorId - the Id of the PoolProcessor

distributorId - the Id of the Distributor

Throws:

AlreadyExistsException - poolProcessorId is already assigned to distributorId

NotFoundException - poolProcessorId or distributorId not found

NullArgumentException - poolProcessorId or distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignPoolProcessorFromDistributor

void unassignPoolProcessorFromDistributor(Id poolProcessorId,
                                        Id distributorId)
                                          throws NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Removes a PoolProcessor from a Distributor.

Parameters:

poolProcessorId - the Id of the PoolProcessor

distributorId - the Id of the Distributor

Throws:

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

NullArgumentException - poolProcessorId or distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.