org.osid.provisioning

Interface BrokerDistributorAssignmentSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface BrokerDistributorAssignmentSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
void	assignBrokerToDistributor(Id brokerId, Id distributorId) Adds an existing Broker to a Distributor.
boolean	canAssignBrokers() Tests if this user can alter broker/distributor mappings.
boolean	canAssignBrokersToDistributor(Id distributorId) Tests if this user can alter broker/distributor mappings.
IdList	getAssignableDistributorIds(Id distributorId) Gets a list of distributors including and under the given distributor node in which any broker can be assigned.
IdList	getAssignableDistributorIdsForBroker(Id distributorId, Id brokerId) Gets a list of distributors including and under the given distributor node in which a specific broker can be assigned.
void	unassignBrokerFromDistributor(Id brokerId, Id distributorId) Removes a Broker from a Distributor.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canAssignBrokers

boolean canAssignBrokers()

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

Compliance:

mandatory - This method must be implemented.

canAssignBrokersToDistributor

boolean canAssignBrokersToDistributor(Id distributorId)

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

getAssignableDistributorIdsForBroker

IdList getAssignableDistributorIdsForBroker(Id distributorId,
                                          Id brokerId)
                                            throws OperationFailedException

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

Parameters:

distributorId - the Id of the Distributor

brokerId - the Id of the Broker

Returns:

list of assignable distributor Ids

Throws:

NullArgumentException - distributorId or brokerId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignBrokerToDistributor

void assignBrokerToDistributor(Id brokerId,
                             Id distributorId)
                               throws AlreadyExistsException,
                                      NotFoundException,
                                      OperationFailedException,
                                      PermissionDeniedException

Adds an existing Broker to a Distributor.

Parameters:

brokerId - the Id of the Broker

distributorId - the Id of the Distributor

Throws:

AlreadyExistsException - brokerId is already assigned to distributorId

NotFoundException - brokerId or distributorId not found

NullArgumentException - brokerId or distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignBrokerFromDistributor

void unassignBrokerFromDistributor(Id brokerId,
                                 Id distributorId)
                                   throws NotFoundException,
                                          OperationFailedException,
                                          PermissionDeniedException

Removes a Broker from a Distributor.

Parameters:

brokerId - the Id of the Broker

distributorId - the Id of the Distributor

Throws:

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

NullArgumentException - brokerId or distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.