Interface BrokerProcessorRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface BrokerProcessorRuleApplicationSession
extends OsidSession

This session provides methods to apply BrokerProcessors to Brokers. Multiple BrokerProcessors applied to an Broker may be sequenced such that the first positive evaluation results in the BrokerProcessor used.

Method Summary

Modifier and Type	Method	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 brokerProcessorId, Id brokerId, Id referenceId)	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 an existing BrokerProcessor from a Broker.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

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 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 an existing 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 already 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 the BrokerProcessor

brokerId - the Id of the 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 brokerProcessorId,
 Id brokerId,
 Id referenceId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

brokerProcessorId - the Id of the BrokerProcessor

brokerId - the Id of the 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.

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 the 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.