org.osid.provisioning.rules

Interface BrokerConstrainerDistributorAssignmentSession

All Superinterfaces:

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

public interface BrokerConstrainerDistributorAssignmentSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
void	assignBrokerConstrainerToDistributor(Id brokerConstrainerId, Id distributorId) Adds an existing BrokerConstrainer to a Distributor.
boolean	canAssignBrokerConstrainers() Tests if this user can alter broker constrainer/distributor mappings.
boolean	canAssignBrokerConstrainersToDistributor(Id distributorId) Tests if this user can alter broker constrainer/distributor mappings.
IdList	getAssignableDistributorIds(Id distributorId) Gets a list of distributors including and under the given distributor node in which any broker constrainer can be assigned.
IdList	getAssignableDistributorIdsForBrokerConstrainer(Id distributorId, Id brokerConstrainerId) Gets a list of distributors including and under the given distributor node in which a specific broker constrainer can be assigned.
void	unassignBrokerConstrainerFromDistributor(Id brokerConstrainerId, Id distributorId) Removes a BrokerConstrainer 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

canAssignBrokerConstrainers

boolean canAssignBrokerConstrainers()

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

canAssignBrokerConstrainersToDistributor

boolean canAssignBrokerConstrainersToDistributor(Id distributorId)

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

getAssignableDistributorIdsForBrokerConstrainer

IdList getAssignableDistributorIdsForBrokerConstrainer(Id distributorId,
                                                     Id brokerConstrainerId)
                                                       throws OperationFailedException

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

Parameters:

distributorId - the Id of the Distributor

brokerConstrainerId - the Id of the BrokerConstrainer

Returns:

list of assignable distributor Ids

Throws:

NullArgumentException - distributorId or brokerConstrainerId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignBrokerConstrainerToDistributor

void assignBrokerConstrainerToDistributor(Id brokerConstrainerId,
                                        Id distributorId)
                                          throws AlreadyExistsException,
                                                 NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Adds an existing BrokerConstrainer to a Distributor.

Parameters:

brokerConstrainerId - the Id of the BrokerConstrainer

distributorId - the Id of the Distributor

Throws:

AlreadyExistsException - brokerConstrainerId is already assigned to distributorId

NotFoundException - brokerConstrainerId or distributorId not found

NullArgumentException - brokerConstrainerId or distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignBrokerConstrainerFromDistributor

void unassignBrokerConstrainerFromDistributor(Id brokerConstrainerId,
                                            Id distributorId)
                                              throws NotFoundException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

Removes a BrokerConstrainer from a Distributor.

Parameters:

brokerConstrainerId - the Id of the BrokerConstrainer

distributorId - the Id of the Distributor

Throws:

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

NullArgumentException - brokerConstrainerId or distributorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.