org.osid.provisioning.rules

Interface PoolConstrainerEnablerDistributorAssignmentSession

All Superinterfaces:

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

public interface PoolConstrainerEnablerDistributorAssignmentSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
void	assignPoolConstrainerEnablerToDistributor(Id poolConstrainerEnablerId, Id distributorId) Adds an existing PoolConstrainerEnabler to a Distributor.
boolean	canAssignPoolConstrainerEnablers() Tests if this user can alter pool constrainer enabler/distributor mappings.
boolean	canAssignPoolConstrainerEnablersToDistributor(Id distributorId) Tests if this user can alter pool constrainer enabler/distributor mappings.
IdList	getAssignableDistributorIds(Id distributorId) Gets a list of distributors including and under the given distributor node in which any pool constrainer enabler can be assigned.
IdList	getAssignableDistributorIdsForPoolConstrainerEnabler(Id distributorId, Id poolConstrainerEnablerId) Gets a list of distributors including and under the given distributor node in which a specific pool constrainer enabler can be assigned.
void	unassignPoolConstrainerEnablerFromDistributor(Id poolConstrainerEnablerId, Id distributorId) Removes a PoolConstrainerEnabler 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

canAssignPoolConstrainerEnablers

boolean canAssignPoolConstrainerEnablers()

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

canAssignPoolConstrainerEnablersToDistributor

boolean canAssignPoolConstrainerEnablersToDistributor(Id distributorId)

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

getAssignableDistributorIdsForPoolConstrainerEnabler

IdList getAssignableDistributorIdsForPoolConstrainerEnabler(Id distributorId,
                                                          Id poolConstrainerEnablerId)
                                                            throws OperationFailedException

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

Parameters:

distributorId - the Id of the Distributor

poolConstrainerEnablerId - the Id of the PoolConstrainerEnabler

Returns:

list of assignable distributor Ids

Throws:

NullArgumentException - distributorId or poolConstrainerEnablerId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignPoolConstrainerEnablerToDistributor

void assignPoolConstrainerEnablerToDistributor(Id poolConstrainerEnablerId,
                                             Id distributorId)
                                               throws AlreadyExistsException,
                                                      NotFoundException,
                                                      OperationFailedException,
                                                      PermissionDeniedException

Adds an existing PoolConstrainerEnabler to a Distributor.

Parameters:

poolConstrainerEnablerId - the Id of the PoolConstrainerEnabler

distributorId - the Id of the Distributor

Throws:

AlreadyExistsException - poolConstrainerEnablerId is already assigned to distributorId

NotFoundException - poolConstrainerEnablerId or distributorId not found

NullArgumentException - poolConstrainerEnablerId or distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignPoolConstrainerEnablerFromDistributor

void unassignPoolConstrainerEnablerFromDistributor(Id poolConstrainerEnablerId,
                                                 Id distributorId)
                                                   throws NotFoundException,
                                                          OperationFailedException,
                                                          PermissionDeniedException

Removes a PoolConstrainerEnabler from a Distributor.

Parameters:

poolConstrainerEnablerId - the Id of the PoolConstrainerEnabler

distributorId - the Id of the Distributor

Throws:

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

NullArgumentException - poolConstrainerEnablerId or distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.