Interface BrokerProcessorEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface BrokerProcessorEnablerRuleApplicationSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
void	assignBrokerProcessorEnablerToBrokerProcessor(Id brokerProcessorEnablerId, Id brokerProcessorId)	Adds an existing BrokerProcessorEnabler to a BrokerProcessor.
boolean	canAssignBrokerProcessorEnablers()	Tests if this user can alter broker processor enabler/broker processor mappings.
boolean	canSequenceBrokerProcessorEnablers()	Tests if this user can order BrokerProcessorEnablers.
Distributor	getDistributor()	Gets the Distributor associated with this session.
Id	getDistributorId()	Gets the Distributor Id associated with this session.
void	moveBrokerProcessorEnablerAhead(Id brokerProcessorEnablerId, Id brokerProcessorId, Id referenceId)	Reorders broker processor enablers for a broker processor by moving the specified broker processor enabler in front of a reference broker processor enabler.
void	moveBrokerProcessorEnablerBehind(Id brokerProcessorEnablerId, Id brokerProcessorId, Id referenceId)	Reorders broker processor enablers for a broker processor by moving the specified broker processor enabler behind a reference broker processor enabler.
void	orderBrokerProcessorEnablers(Id[] brokerProcessorEnablerIds, Id brokerProcessorId)	Reorders a set of broker processor enablers for a broker processor.
void	unassignBrokerProcessorEnablerFromBrokerProcessor(Id brokerProcessorEnablerId, Id brokerProcessorId)	Removes an existing BrokerProcessorEnabler from a BrokerProcessor.

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.

canAssignBrokerProcessorEnablers

boolean canAssignBrokerProcessorEnablers()

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

assignBrokerProcessorEnablerToBrokerProcessor

void assignBrokerProcessorEnablerToBrokerProcessor(Id brokerProcessorEnablerId,
 Id brokerProcessorId)
                                            throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing BrokerProcessorEnabler to a BrokerProcessor.

Parameters:

brokerProcessorEnablerId - the Id of the BrokerProcessorEnabler

brokerProcessorId - the Id of the BrokerProcessor

Throws:

AlreadyExistsException - brokerProcessorEnablerId already applied to brokerProcessorId

NotFoundException - brokerProcessorEnablerId or brokerProcessorId not found

NullArgumentException - brokerProcessorEnablerId or brokerProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignBrokerProcessorEnablerFromBrokerProcessor

void unassignBrokerProcessorEnablerFromBrokerProcessor(Id brokerProcessorEnablerId,
 Id brokerProcessorId)
                                                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an existing BrokerProcessorEnabler from a BrokerProcessor.

Parameters:

brokerProcessorEnablerId - the Id of the BrokerProcessorEnabler

brokerProcessorId - the Id of the BrokerProcessor

Throws:

NotFoundException - brokerProcessorEnablerId or brokerProcessorId not found or brokerProcessorEnablerId already applied to brokerProcessorId

NullArgumentException - brokerProcessorEnablerId or brokerProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceBrokerProcessorEnablers

boolean canSequenceBrokerProcessorEnablers()

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

Compliance:

mandatory - This method must be implemented.

moveBrokerProcessorEnablerAhead

void moveBrokerProcessorEnablerAhead(Id brokerProcessorEnablerId,
 Id brokerProcessorId,
 Id referenceId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

brokerProcessorEnablerId - the Id of the BrokerProcessorEnabler

brokerProcessorId - the Id of the BrokerProcessor

referenceId - the reference broker processor enabler Id

Throws:

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

NullArgumentException - brokerProcessorEnablerId, brokerProcessorId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveBrokerProcessorEnablerBehind

void moveBrokerProcessorEnablerBehind(Id brokerProcessorEnablerId,
 Id brokerProcessorId,
 Id referenceId)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

brokerProcessorEnablerId - the Id of the BrokerProcessorEnabler

brokerProcessorId - the Id of the BrokerProcessor

referenceId - the reference broker processor Id

Throws:

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

NullArgumentException - brokerProcessorEnablerId, brokerProcessorId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderBrokerProcessorEnablers

void orderBrokerProcessorEnablers(Id[] brokerProcessorEnablerIds,
 Id brokerProcessorId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of broker processor enablers for a broker processor.

Parameters:

brokerProcessorEnablerIds - the Ids for a set of BrokerProcessorEnablers

brokerProcessorId - the Id of the BrokerProcessor

Throws:

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

NullArgumentException - brokerProcessorEnablerIds or brokerProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.