Interface ProvisionEnablerDistributorAssignmentSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ProvisionEnablerDistributorAssignmentSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	assignProvisionEnablerToDistributor(Id provisionEnablerId, Id distributorId)	Adds an existing ProvisionEnabler to a Distributor .
boolean	canAssignProvisionEnablers()	Tests if this user can alter provision enabler/distributor mappings.
boolean	canAssignProvisionEnablerToDistributor(Id distributorId)	Tests if this user can alter provision enabler/distributor mappings.
IdList	getAssignableDistributorIds(Id distributorId)	Gets a list of distributors including and under the given distributor node in which any provision enabler can be assigned.
IdList	getAssignableDistributorIdsForProvisionEnabler(Id distributorId, Id provisionEnablerId)	Gets a list of distributors including and under the given distributor node in which a specific provision enabler can be assigned.
void	reassignProvisionEnablerToDistributor(Id provisionEnablerId, Id fromDistributorId, Id toDistributorId)	Moves a ProvisionEnabler from one Distributor to another.
void	unassignProvisionEnablerFromDistributor(Id provisionEnablerId, Id distributorId)	Removes a ProvisionEnabler 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

canAssignProvisionEnablers

boolean canAssignProvisionEnablers()

Tests if this user can alter provision 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. T his is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.

Returns:

false if mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canAssignProvisionEnablerToDistributor

boolean canAssignProvisionEnablerToDistributor(Id distributorId)

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

getAssignableDistributorIdsForProvisionEnabler

IdList getAssignableDistributorIdsForProvisionEnabler(Id distributorId,
 Id provisionEnablerId)
                                               throws OperationFailedException

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

Parameters:

distributorId - the Id of the Distributor

provisionEnablerId - the Id of the ProvisionEnabler

Returns:

list of assignable distributor Ids

Throws:

NullArgumentException - distributorId or provisionEnablerId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignProvisionEnablerToDistributor

void assignProvisionEnablerToDistributor(Id provisionEnablerId,
 Id distributorId)
                                  throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing ProvisionEnabler to a Distributor .

Parameters:

provisionEnablerId - the Id of the ProvisionEnabler

distributorId - the Id of the Distributor

Throws:

AlreadyExistsException - provisionEnablerId is already assigned to distributorId

NotFoundException - provisionEnablerId or distributorId not found

NullArgumentException - provisionEnablerId or distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignProvisionEnablerFromDistributor

void unassignProvisionEnablerFromDistributor(Id provisionEnablerId,
 Id distributorId)
                                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a ProvisionEnabler from a Distributor .

Parameters:

provisionEnablerId - the Id of the ProvisionEnabler

distributorId - the Id of the Distributor

Throws:

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

NullArgumentException - provisionEnablerId or distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

reassignProvisionEnablerToDistributor

void reassignProvisionEnablerToDistributor(Id provisionEnablerId,
 Id fromDistributorId,
 Id toDistributorId)
                                    throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

provisionEnablerId - the Id of the ProvisionEnabler

fromDistributorId - the Id of the current Distributor

toDistributorId - the Id of the destination Distributor

Throws:

AlreadyExistsException - provisionEnablerId already assigned to toDistributorId

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

NullArgumentException - provisionEnablerId, fromDistributorId , or toDistributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.