Interface ProvisionDistributorAssignmentSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ProvisionDistributorAssignmentSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	assignProvisionToDistributor(Id provisionId, Id distributorId)	Adds an existing Provision to a Distributor .
boolean	canAssignProvisions()	Tests if this user can alter provision/distributor mappings.
boolean	canAssignProvisionsToDistributor(Id distributorId)	Tests if this user can alter provision/distributor mappings.
IdList	getAssignableDistributorIds(Id distributorId)	Gets a list of distributors including and under the given distributor node in which any provision can be assigned.
IdList	getAssignableDistributorIdsForProvision(Id distributorId, Id provisionId)	Gets a list of distributors including and under the given distributor node in which a specific provision can be assigned.
void	reassignProvisionToDistributor(Id provisionId, Id fromDistributorId, Id toDistributorId)	Moves a Provision from one Distributor to another.
void	unassignProvisionFromDistributor(Id provisionId, Id distributorId)	Removes a Provision 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

canAssignProvisions

boolean canAssignProvisions()

Tests if this user can alter provision/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 provisioning is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canAssignProvisionsToDistributor

boolean canAssignProvisionsToDistributor(Id distributorId)

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

getAssignableDistributorIdsForProvision

IdList getAssignableDistributorIdsForProvision(Id distributorId,
 Id provisionId)
                                        throws OperationFailedException

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

Parameters:

distributorId - the Id of the Distributor

provisionId - the Id of the Provision

Returns:

list of assignable distributor Ids

Throws:

NullArgumentException - distributorId or provisionId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignProvisionToDistributor

void assignProvisionToDistributor(Id provisionId,
 Id distributorId)
                           throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing Provision to a Distributor .

Parameters:

provisionId - the Id of the Provision

distributorId - the Id of the Distributor

Throws:

AlreadyExistsException - provisionId is slready assigned to distributorId

NotFoundException - provisionId or distributorId not found

NullArgumentException - provisionId or distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignProvisionFromDistributor

void unassignProvisionFromDistributor(Id provisionId,
 Id distributorId)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a Provision from a Distributor .

Parameters:

provisionId - the Id of the Provision

distributorId - the Id of the Distributor

Throws:

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

NullArgumentException - provisionId or distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

reassignProvisionToDistributor

void reassignProvisionToDistributor(Id provisionId,
 Id fromDistributorId,
 Id toDistributorId)
                             throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

provisionId - the Id of the Provision

fromDistributorId - the Id of the current Distributor

toDistributorId - the Id of the destination Distributor

Throws:

AlreadyExistsException - provisionId already assigned to toDistributorId

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

NullArgumentException - provisionId, fromDistributorId , or toDistributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.