Interface PoolDistributorAssignmentSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface PoolDistributorAssignmentSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	assignPoolToDistributor(Id poolId, Id distributorId)	Adds an existing Pool to a Distributor .
boolean	canAssignPools()	Tests if this user can alter pool/distributor mappings.
boolean	canAssignPoolsToDistributor(Id distributorId)	Tests if this user can alter pool/distributor mappings.
IdList	getAssignableDistributorIds(Id distributorId)	Gets a list of distributors including and under the given distributor node in which any pool can be assigned.
IdList	getAssignableDistributorIdsForPool(Id distributorId, Id poolId)	Gets a list of distributors including and under the given distributor node in which a specific pool can be assigned.
void	reassignPoolToDistributor(Id poolId, Id fromDistributorId, Id toDistributorId)	Moves a Pool from one Distributor to another.
void	unassignPoolFromDistributor(Id poolId, Id distributorId)	Removes a Pool from a Distributor .

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

canAssignPools

boolean canAssignPools()

Tests if this user can alter pool/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 assignment operations to unauthorized users.

Returns:

false if pool assignment is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canAssignPoolsToDistributor

boolean canAssignPoolsToDistributor(Id distributorId)

Tests if this user can alter pool/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 assignment operations to unauthorized users.

Parameters:

distributorId - the Id of the Distributor

Returns:

false if pool assignment 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 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.

getAssignableDistributorIdsForPool

IdList getAssignableDistributorIdsForPool(Id distributorId,
 Id poolId)
                                   throws OperationFailedException

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

Parameters:

distributorId - the Id of the Distributor

poolId - the Id of the Pool

Returns:

list of assignable distributor Ids

Throws:

NullArgumentException - distributorId or poolId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignPoolToDistributor

void assignPoolToDistributor(Id poolId,
 Id distributorId)
                      throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing Pool to a Distributor .

Parameters:

poolId - the Id of the Pool

distributorId - the Id of the Distributor

Throws:

AlreadyExistsException - poolId is already assigned to distributorId

NotFoundException - poolId or distributorId not found

NullArgumentException - poolId or distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignPoolFromDistributor

void unassignPoolFromDistributor(Id poolId,
 Id distributorId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a Pool from a Distributor .

Parameters:

poolId - the Id of the Pool

distributorId - the Id of the Distributor

Throws:

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

NullArgumentException - poolId or distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

reassignPoolToDistributor

void reassignPoolToDistributor(Id poolId,
 Id fromDistributorId,
 Id toDistributorId)
                        throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Moves a Pool from one Distributor to another. Mappings to other Distributors are unaffected.

Parameters:

poolId - the Id of the Pool

fromDistributorId - the Id of the current Distributor

toDistributorId - the Id of the destination Distributor

Throws:

AlreadyExistsException - poolId already assigned to toDistributorId

NotFoundException - poolId, fromDistributorId , or toDistributorId not found or poolId not mapped to fromDistributorId

NullArgumentException - poolId, fromDistributorId , or toDistributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.