Interface BrokerEnablerDistributorAssignmentSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface BrokerEnablerDistributorAssignmentSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	assignBrokerEnablerToDistributor(Id brokerEnablerId, Id distributorId)	Adds an existing BrokerEnabler to a Distributor .
boolean	canAssignBrokerEnablers()	Tests if this user can alter broker enabler/distributor mappings.
boolean	canAssignBrokerEnablerToDistributor(Id distributorId)	Tests if this user can alter broker enabler/distributor mappings.
IdList	getAssignableDistributorIds(Id distributorId)	Gets a list of distributors including and under the given distributor node in which any broker enabler can be assigned.
IdList	getAssignableDistributorIdsForBrokerEnabler(Id distributorId, Id brokerEnablerId)	Gets a list of distributors including and under the given distributor node in which a specific broker enabler can be assigned.
void	reassignBrokerEnablerToDistributor(Id brokerEnablerId, Id fromDistributorId, Id toDistributorId)	Moves a BrokerEnabler from one Distributor to another.
void	unassignBrokerEnablerFromDistributor(Id brokerEnablerId, Id distributorId)	Removes a BrokerEnabler 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

canAssignBrokerEnablers

boolean canAssignBrokerEnablers()

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

canAssignBrokerEnablerToDistributor

boolean canAssignBrokerEnablerToDistributor(Id distributorId)

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

getAssignableDistributorIdsForBrokerEnabler

IdList getAssignableDistributorIdsForBrokerEnabler(Id distributorId,
 Id brokerEnablerId)
                                            throws OperationFailedException

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

Parameters:

distributorId - the Id of the Distributor

brokerEnablerId - the Id of the BrokerEnabler

Returns:

list of assignable distributor Ids

Throws:

NullArgumentException - distributorId or brokerEnablerId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignBrokerEnablerToDistributor

void assignBrokerEnablerToDistributor(Id brokerEnablerId,
 Id distributorId)
                               throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing BrokerEnabler to a Distributor .

Parameters:

brokerEnablerId - the Id of the BrokerEnabler

distributorId - the Id of the Distributor

Throws:

AlreadyExistsException - brokerEnablerId is already assigned to distributorId

NotFoundException - brokerEnablerId or distributorId not found

NullArgumentException - brokerEnablerId or distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignBrokerEnablerFromDistributor

void unassignBrokerEnablerFromDistributor(Id brokerEnablerId,
 Id distributorId)
                                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a BrokerEnabler from a Distributor .

Parameters:

brokerEnablerId - the Id of the BrokerEnabler

distributorId - the Id of the Distributor

Throws:

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

NullArgumentException - brokerEnablerId or distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

reassignBrokerEnablerToDistributor

void reassignBrokerEnablerToDistributor(Id brokerEnablerId,
 Id fromDistributorId,
 Id toDistributorId)
                                 throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

brokerEnablerId - the Id of the BrokerEnabler

fromDistributorId - the Id of the current Distributor

toDistributorId - the Id of the destination Distributor

Throws:

AlreadyExistsException - brokerEnablerId already assigned to toDistributorId

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

NullArgumentException - brokerEnablerId, fromDistributorId , or toDistributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.