Interface BrokerConstrainerEnablerDistributorAssignmentSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface BrokerConstrainerEnablerDistributorAssignmentSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	assignBrokerConstrainerEnablerToDistributor(Id brokerConstrainerEnablerId, Id distributorId)	Adds an existing BrokerConstrainerEnabler to a Distributor .
boolean	canAssignBrokerConstrainerEnablers()	Tests if this user can alter broker constrainer enabler/distributor mappings.
boolean	canAssignBrokerConstrainerEnablerToDistributor(Id distributorId)	Tests if this user can alter broker constrainer enabler/distributor mappings.
IdList	getAssignableDistributorIds(Id distributorId)	Gets a list of distributors including and under the given distributor node in which any broker constrainer enabler can be assigned.
IdList	getAssignableDistributorIdsForBrokerConstrainerEnabler(Id distributorId, Id brokerConstrainerEnablerId)	Gets a list of distributors including and under the given distributor node in which a specific broker constrainer enabler can be assigned.
void	reassignBrokerConstrainerEnablerToDistributor(Id brokerConstrainerEnablerId, Id fromDistributorId, Id toDistributorId)	Moves a BrokerConstrainerEnabler from one Distributor to another.
void	unassignBrokerConstrainerEnablerFromDistributor(Id brokerConstrainerEnablerId, Id distributorId)	Removes a BrokerConstrainerEnabler 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

canAssignBrokerConstrainerEnablers

boolean canAssignBrokerConstrainerEnablers()

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

canAssignBrokerConstrainerEnablerToDistributor

boolean canAssignBrokerConstrainerEnablerToDistributor(Id distributorId)

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

getAssignableDistributorIdsForBrokerConstrainerEnabler

IdList getAssignableDistributorIdsForBrokerConstrainerEnabler(Id distributorId,
 Id brokerConstrainerEnablerId)
                                                       throws OperationFailedException

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

Parameters:

distributorId - the Id of the Distributor

brokerConstrainerEnablerId - the Id of the BrokerConstrainerEnabler

Returns:

list of assignable distributor Ids

Throws:

NullArgumentException - distributorId or brokerConstrainerEnablerId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignBrokerConstrainerEnablerToDistributor

void assignBrokerConstrainerEnablerToDistributor(Id brokerConstrainerEnablerId,
 Id distributorId)
                                          throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing BrokerConstrainerEnabler to a Distributor .

Parameters:

brokerConstrainerEnablerId - the Id of the BrokerConstrainerEnabler

distributorId - the Id of the Distributor

Throws:

AlreadyExistsException - brokerConstrainerEnablerId is already assigned to distributorId

NotFoundException - brokerConstrainerEnablerId or distributorId not found

NullArgumentException - brokerConstrainerEnablerId or distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignBrokerConstrainerEnablerFromDistributor

void unassignBrokerConstrainerEnablerFromDistributor(Id brokerConstrainerEnablerId,
 Id distributorId)
                                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a BrokerConstrainerEnabler from a Distributor .

Parameters:

brokerConstrainerEnablerId - the Id of the BrokerConstraienrEnabler

distributorId - the Id of the Distributor

Throws:

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

NullArgumentException - brokerConstrainerEnablerId or distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

reassignBrokerConstrainerEnablerToDistributor

void reassignBrokerConstrainerEnablerToDistributor(Id brokerConstrainerEnablerId,
 Id fromDistributorId,
 Id toDistributorId)
                                            throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

brokerConstrainerEnablerId - the Id of the BrokerConstrainerEnabler

fromDistributorId - the Id of the current Distributor

toDistributorId - the Id of the destination Distributor

Throws:

AlreadyExistsException - brokerConstrainerEnablerId already assigned to toDistributorId

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

NullArgumentException - brokerConstrainerEnablerId, fromDistributorId , or toDistributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.