org.osid.provisioning.rules

Interface BrokerProcessorDistributorAssignmentSession

All Superinterfaces:

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

public interface BrokerProcessorDistributorAssignmentSession
extends OsidSession

This session provides methods to re-assign BrokerProcessor to Distributor mappings. A BrokerProcessor may appear in multiple Distributor objects 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

Methods

Modifier and Type	Method and 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	canAssignBrokerProcessorsToDistributor(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	unassignBrokerProcessorFromDistributor(Id brokerProcessorId, Id distributorId) Removes a BrokerProcessor 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

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. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returns:

false if mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canAssignBrokerProcessorsToDistributor

boolean canAssignBrokerProcessorsToDistributor(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. This is intended as a hint to an application that may opt not to offer lookup 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 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.