org.osid.provisioning.rules

Interface PoolProcessorEnablerDistributorAssignmentSession

All Superinterfaces:

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

public interface PoolProcessorEnablerDistributorAssignmentSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
void	assignPoolProcessorEnablerToDistributor(Id poolProcessorEnablerId, Id distributorId) Adds a existing PoolProcessorEnabler to a Distributor.
boolean	canAssignPoolProcessorEnablers() Tests if this user can alter pool processor enabler/distributor mappings.
boolean	canAssignPoolProcessorEnablersToDistributor(Id distributorId) Tests if this user can alter pool processor enabler/distributor mappings.
IdList	getAssignableDistributorIds(Id distributorId) Gets a list of distributors including and under the given distributor node in which any pool processor enabler can be assigned.
IdList	getAssignableDistributorIdsForPoolProcessorEnabler(Id distributorId, Id poolProcessorEnablerId) Gets a list of distributors including and under the given distributor node in which a specific pool processor enabler can be assigned.
void	unassignPoolProcessorEnablerFromDistributor(Id poolProcessorEnablerId, Id distributorId) Removes a PoolProcessorEnabler 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

canAssignPoolProcessorEnablers

boolean canAssignPoolProcessorEnablers()

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

canAssignPoolProcessorEnablersToDistributor

boolean canAssignPoolProcessorEnablersToDistributor(Id distributorId)

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

getAssignableDistributorIdsForPoolProcessorEnabler

IdList getAssignableDistributorIdsForPoolProcessorEnabler(Id distributorId,
                                                        Id poolProcessorEnablerId)
                                                          throws OperationFailedException

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

Parameters:

distributorId - the Id of the Distributor

poolProcessorEnablerId - the Id of the PoolProcessorEnabler

Returns:

list of assignable distributor Ids

Throws:

NullArgumentException - distributorId or poolProcessorEnablerId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignPoolProcessorEnablerToDistributor

void assignPoolProcessorEnablerToDistributor(Id poolProcessorEnablerId,
                                           Id distributorId)
                                             throws AlreadyExistsException,
                                                    NotFoundException,
                                                    OperationFailedException,
                                                    PermissionDeniedException

Adds a existing PoolProcessorEnabler to a Distributor.

Parameters:

poolProcessorEnablerId - the Id of the PoolProcessorEnabler

distributorId - the Id of the Distributor

Throws:

AlreadyExistsException - poolProcessorEnablerId is already assigned to distributorId

NotFoundException - poolProcessorEnablerId or distributorId not found

NullArgumentException - poolProcessorEnablerId or distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignPoolProcessorEnablerFromDistributor

void unassignPoolProcessorEnablerFromDistributor(Id poolProcessorEnablerId,
                                               Id distributorId)
                                                 throws NotFoundException,
                                                        OperationFailedException,
                                                        PermissionDeniedException

Removes a PoolProcessorEnabler from a Distributor.

Parameters:

poolProcessorEnablerId - the Id of the PoolProcessorEnabler

distributorId - the Id of the Distributor

Throws:

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

NullArgumentException - poolProcessorEnablerId or distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.