Interface BrokerProcessorDistributorAssignmentSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface BrokerProcessorDistributorAssignmentSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	assignBrokerProcessorToDistributor(Id brokerProcessorId, Id distributorId)	Adds an existing BrokerProcessor to a Distributor .
boolean	canAssignBrokerProcessors()	Tests if this user can alter broker processor/distributor mappings.
boolean	canAssignBrokerProcessorToDistributor(Id distributorId)	Tests if this user can alter broker processor/distributor mappings.
IdList	getAssignableDistributorIds(Id distributorId)	Gets a list of distributors including and under the given distributor node in which any broker processor can be assigned.
IdList	getAssignableDistributorIdsForBrokerProcessor(Id distributorId, Id brokerProcessorId)	Gets a list of distributors including and under the given distributor node in which a specific broker processor can be assigned.
void	reassignBrokerProcessorToDistributor(Id brokerProcessorId, Id fromDistributorId, Id toDistributorId)	Moves a BrokerProcessor from one Distributor to another.
void	unassignBrokerProcessorFromDistributor(Id brokerProcessorId, Id distributorId)	Removes a BrokerProcessor 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

canAssignBrokerProcessors

boolean canAssignBrokerProcessors()

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

canAssignBrokerProcessorToDistributor

boolean canAssignBrokerProcessorToDistributor(Id distributorId)

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

getAssignableDistributorIdsForBrokerProcessor

IdList getAssignableDistributorIdsForBrokerProcessor(Id distributorId,
 Id brokerProcessorId)
                                              throws OperationFailedException

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

Parameters:

distributorId - the Id of the Distributor

brokerProcessorId - the Id of the BrokerProcessor

Returns:

list of assignable distributor Ids

Throws:

NullArgumentException - distributorId or brokerProcessorId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignBrokerProcessorToDistributor

void assignBrokerProcessorToDistributor(Id brokerProcessorId,
 Id distributorId)
                                 throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing BrokerProcessor to a Distributor .

Parameters:

brokerProcessorId - the Id of the BrokerProcessor

distributorId - the Id of the Distributor

Throws:

AlreadyExistsException - brokerProcessorId is already assigned to distributorId

NotFoundException - brokerProcessorId or distributorId not found

NullArgumentException - brokerProcessorId or distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignBrokerProcessorFromDistributor

void unassignBrokerProcessorFromDistributor(Id brokerProcessorId,
 Id distributorId)
                                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a BrokerProcessor from a Distributor .

Parameters:

brokerProcessorId - the Id of the BrokerProcessor

distributorId - the Id of the Distributor

Throws:

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

NullArgumentException - brokerProcessorId or distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

reassignBrokerProcessorToDistributor

void reassignBrokerProcessorToDistributor(Id brokerProcessorId,
 Id fromDistributorId,
 Id toDistributorId)
                                   throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

brokerProcessorId - the Id of the BrokerProcessor

fromDistributorId - the Id of the current Distributor

toDistributorId - the Id of the destination Distributor

Throws:

AlreadyExistsException - brokerProcessorId already assigned to toDistributorId

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

NullArgumentException - brokerProcessorId, fromDistributorId , or toDistributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.