org.osid.provisioning.rules

Interface BrokerConstrainerRuleApplicationSession

All Superinterfaces:

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

public interface BrokerConstrainerRuleApplicationSession
extends OsidSession

This session provides methods to apply BrokerConstrainers to Brokers. A Broker with multiple BrokerConstrainers means any positive rule evaluation across the result in an effective Broker.

Method Summary

Methods

Modifier and Type	Method and Description
void	assignBrokerConstrainerToBroker(Id brokerConstrainerId, Id brokerId) Adds an existing BrokerConstrainer to a Broker.
boolean	canAssignBrokerConstrainers() Tests if this user can alter broker constrainer/broker mappings.
boolean	canSequenceBrokerConstrainers() Tests if this user can order BrokerConstrainers.
Distributor	getDistributor() Gets the Distributor associated with this session.
Id	getDistributorId() Gets the Distributor Id associated with this session.
void	moveBrokerConstrainerAhead(Id brokerConstrainerId, Id brokerId, Id referenceId) Reorders broker constrainers for a broker by moving the specified broker constrainer in front of a reference broker.
void	moveBrokerConstrainerBehind(Id brokerConstrainerId, Id brokerId, Id referenceId) Reorders broker constrainers for a broker by moving the specified broker constrainer behind a reference broker.
void	orderBrokerConstrainers(Id[] brokerConstrainerIds, Id brokerId) Reorders a set of broker constrainers for a broker.
void	unassignBrokerConstrainerFromBroker(Id brokerConstrainerId, Id brokerId) Removes a BrokerConstrainer from a Broker.

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

getDistributorId

Id getDistributorId()

Gets the Distributor Id associated with this session.

Returns:

the Distributor Id associated with this session

Compliance:

mandatory - This method must be implemented.

getDistributor

Distributor getDistributor()
                           throws OperationFailedException,
                                  PermissionDeniedException

Gets the Distributor associated with this session.

Returns:

the distributor

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAssignBrokerConstrainers

boolean canAssignBrokerConstrainers()

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

assignBrokerConstrainerToBroker

void assignBrokerConstrainerToBroker(Id brokerConstrainerId,
                                   Id brokerId)
                                     throws AlreadyExistsException,
                                            NotFoundException,
                                            OperationFailedException,
                                            PermissionDeniedException

Adds an existing BrokerConstrainer to a Broker.

Parameters:

brokerConstrainerId - the Id of the BrokerConstrainer

brokerId - the Id of the Broker

Throws:

AlreadyExistsException - brokerConstrainerId is already applied to brokerId

NotFoundException - brokerConstrainerId or brokerId not found

NullArgumentException - brokerConstrainerId or brokerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignBrokerConstrainerFromBroker

void unassignBrokerConstrainerFromBroker(Id brokerConstrainerId,
                                       Id brokerId)
                                         throws NotFoundException,
                                                OperationFailedException,
                                                PermissionDeniedException

Removes a BrokerConstrainer from a Broker.

Parameters:

brokerConstrainerId - the Id of the BrokerConstrainer

brokerId - the Id of the Broker

Throws:

NotFoundException - brokerConstrainerId or brokerId not found or brokerConstrainerId not applied to brokerId

NullArgumentException - brokerConstrainerId or brokerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceBrokerConstrainers

boolean canSequenceBrokerConstrainers()

Tests if this user can order BrokerConstrainers. A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.

Returns:

false if BrokerConstrainer ordering is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

moveBrokerConstrainerAhead

void moveBrokerConstrainerAhead(Id brokerConstrainerId,
                              Id brokerId,
                              Id referenceId)
                                throws NotFoundException,
                                       OperationFailedException,
                                       PermissionDeniedException

Reorders broker constrainers for a broker by moving the specified broker constrainer in front of a reference broker.

Parameters:

brokerConstrainerId - the Id of a BrokerConstrainer

brokerId - the Id of a Broker

referenceId - the reference broker constrainer Id

Throws:

NotFoundException - brokerConstrainerId, brokerId, or referenceId not found or, brokerConstrainerId or referenceId not related to brokerId

NullArgumentException - brokerConstrainerId, brokerId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveBrokerConstrainerBehind

void moveBrokerConstrainerBehind(Id brokerConstrainerId,
                               Id brokerId,
                               Id referenceId)
                                 throws NotFoundException,
                                        OperationFailedException,
                                        PermissionDeniedException

Reorders broker constrainers for a broker by moving the specified broker constrainer behind a reference broker.

Parameters:

brokerConstrainerId - the Id of a BrokerConstrainer

brokerId - the Id of a Broker

referenceId - the reference broker constrainer Id

Throws:

NotFoundException - brokerConstrainerId, brokerId, or referenceId not found or, brokerConstrainerId or referenceId not related to brokerId

NullArgumentException - brokerConstrainerId, brokerId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderBrokerConstrainers

void orderBrokerConstrainers(Id[] brokerConstrainerIds,
                           Id brokerId)
                             throws NotFoundException,
                                    OperationFailedException,
                                    PermissionDeniedException

Reorders a set of broker constrainers for a broker.

Parameters:

brokerConstrainerIds - the Ids for a set of BrokerConstrainers

brokerId - the Id of a Broker

Throws:

NotFoundException - brokerId not found or, a brokerConstrainerId not related to brokerId

NullArgumentException - brokerConstrainerIds or brokerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.