org.osid.provisioning.rules

Interface BrokerProcessorEnablerRuleApplicationSession

All Superinterfaces:

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

public interface BrokerProcessorEnablerRuleApplicationSession
extends OsidSession

This session provides methods to apply BrokerProcessorEnablers to BrokerProcessors. A BrokerProcessor with multiple BrokerProcessorEnablers means any positive rule evaluation across the enablers result in an effective BrokerProcessor.

Method Summary

Methods

Modifier and Type	Method and 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 a BrokerProcessorEnabler from a BrokerProcessor.

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.

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 is 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 a 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 not 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 a BrokerProcessorEnabler

brokerProcessorId - the Id of a 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 a BrokerProcessorEnabler

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

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