org.osid.provisioning.rules

Interface BrokerProcessorRuleApplicationSession

All Superinterfaces:

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

public interface BrokerProcessorRuleApplicationSession
extends OsidSession

This session provides methods to apply BrokerProcessors to Brokers.

Method Summary

Methods

Modifier and Type	Method and Description
void	assignBrokerProcessorToBroker(Id brokerProcessorId, Id brokerId) Adds an existing BrokerProcessor to a Broker.
boolean	canAssignBrokerProcessors() Tests if this user can alter broker processor/broker mappings.
boolean	canSequenceBrokerProcessors() Tests if this user can order BrokerProcessors.
Distributor	getDistributor() Gets the Distributor associated with this session.
Id	getDistributorId() Gets the Distributor Id associated with this session.
void	moveBrokerProcessorAhead(Id brokerProcessorId, Id brokerId, Id referenceId) Reorders broker processors for a broker by moving the specified broker processor in front of a reference broker processor.
void	moveBrokerProcessorBehind(Id brokerProcessorEnablerId, Id brokerProcessorId, Id brokerId) Reorders broker processors for a broker by moving the specified broker processor behind a reference broker processor.
void	orderBrokerProcessors(Id[] brokerProcessorIds, Id brokerId) Reorders a set of broker processors for a broker.
void	unassignBrokerProcessorFromBroker(Id brokerProcessorId, Id brokerId) Removes a BrokerProcessor 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.

canAssignBrokerProcessors

boolean canAssignBrokerProcessors()

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

assignBrokerProcessorToBroker

void assignBrokerProcessorToBroker(Id brokerProcessorId,
                                 Id brokerId)
                                   throws AlreadyExistsException,
                                          NotFoundException,
                                          OperationFailedException,
                                          PermissionDeniedException

Adds an existing BrokerProcessor to a Broker.

Parameters:

brokerProcessorId - the Id of the BrokerProcessor

brokerId - the Id of the Broker

Throws:

AlreadyExistsException - brokerProcessorId is already applied to brokerId

NotFoundException - brokerProcessorId or brokerId not found

NullArgumentException - brokerProcessorId or brokerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignBrokerProcessorFromBroker

void unassignBrokerProcessorFromBroker(Id brokerProcessorId,
                                     Id brokerId)
                                       throws NotFoundException,
                                              OperationFailedException,
                                              PermissionDeniedException

Removes a BrokerProcessor from a Broker.

Parameters:

brokerProcessorId - the Id of the BrokerProcessor

brokerId - the Id of the Broker

Throws:

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

NullArgumentException - brokerProcessorId or brokerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceBrokerProcessors

boolean canSequenceBrokerProcessors()

Tests if this user can order BrokerProcessors. 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 BrokerProcessor ordering is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

moveBrokerProcessorAhead

void moveBrokerProcessorAhead(Id brokerProcessorId,
                            Id brokerId,
                            Id referenceId)
                              throws NotFoundException,
                                     OperationFailedException,
                                     PermissionDeniedException

Reorders broker processors for a broker by moving the specified broker processor in front of a reference broker processor.

Parameters:

brokerProcessorId - the Id of a BrokerProcessor

brokerId - the Id of a Broker

referenceId - the reference broker processor Id

Throws:

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

NullArgumentException - brokerProcessorId, brokerId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveBrokerProcessorBehind

void moveBrokerProcessorBehind(Id brokerProcessorEnablerId,
                             Id brokerProcessorId,
                             Id brokerId)
                               throws NotFoundException,
                                      OperationFailedException,
                                      PermissionDeniedException

Reorders broker processors for a broker by moving the specified broker processor behind a reference broker processor.

Parameters:

brokerProcessorEnablerId - the Id of a BrokerProcessor

brokerProcessorId - the Id of a Broker

brokerId - the reference broker processor Id

Throws:

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

NullArgumentException - brokerProcessorId, brokerId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderBrokerProcessors

void orderBrokerProcessors(Id[] brokerProcessorIds,
                         Id brokerId)
                           throws NotFoundException,
                                  OperationFailedException,
                                  PermissionDeniedException

Reorders a set of broker processors for a broker.

Parameters:

brokerProcessorIds - the Ids for a set of BrokerProcessors

brokerId - the Id of a Broker

Throws:

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

NullArgumentException - brokerProcessorIds or brokerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.