Interface PoolProcessorEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface PoolProcessorEnablerRuleApplicationSession
extends OsidSession

This session provides methods to apply PoolProcessorEnablers to PoolProcessors. Multiple PoolProcessorEnablers applied to an PoolProcessor may be sequenced such that the first positive evaluation results in the PoolProcessorEnabler used.

Method Summary

Modifier and Type	Method	Description
void	assignPoolProcessorEnablerToPoolProcessor(Id poolProcessorEnablerId, Id poolProcessorId)	Adds an existing PoolProcessorEnabler to a PoolProcessor.
boolean	canAssignPoolProcessorEnablers()	Tests if this user can alter pool processor enabler/pool processor mappings.
boolean	canSequencePoolProcessorEnablers()	Tests if this user can order PoolProcessorEnablers.
Distributor	getDistributor()	Gets the Distributor associated with this session.
Id	getDistributorId()	Gets the Distributor Id associated with this session.
void	movePoolProcessorEnablerAhead(Id poolProcessorEnablerId, Id poolProcessorId, Id referenceId)	Reorders pool processor enablers for a pool processor by moving the specified pool processor enabler in front of a reference pool processor enabler.
void	movePoolProcessorEnablerBehind(Id poolProcessorEnablerId, Id poolProcessorId, Id referenceId)	Reorders pool processor enablers for a pool processor by moving the specified pool processor enabler behind a reference pool processor enabler.
void	orderPoolProcessorEnablers(Id[] poolProcessorEnablerIds, Id poolProcessorId)	Reorders a set of pool processor enablers for a pool processor.
void	unassignPoolProcessorEnablerFromPoolProcessor(Id poolProcessorEnablerId, Id poolProcessorId)	Removes an existing PoolProcessorEnabler from a PoolProcessor.

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.

canAssignPoolProcessorEnablers

boolean canAssignPoolProcessorEnablers()

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

assignPoolProcessorEnablerToPoolProcessor

void assignPoolProcessorEnablerToPoolProcessor(Id poolProcessorEnablerId,
 Id poolProcessorId)
                                        throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing PoolProcessorEnabler to a PoolProcessor.

Parameters:

poolProcessorEnablerId - the Id of the PoolProcessorEnabler

poolProcessorId - the Id of the PoolProcessor

Throws:

AlreadyExistsException - poolProcessorEnablerId already applied to poolProcessorId

NotFoundException - poolProcessorEnablerId or poolProcessorId not found

NullArgumentException - poolProcessorEnablerId or poolProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignPoolProcessorEnablerFromPoolProcessor

void unassignPoolProcessorEnablerFromPoolProcessor(Id poolProcessorEnablerId,
 Id poolProcessorId)
                                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an existing PoolProcessorEnabler from a PoolProcessor.

Parameters:

poolProcessorEnablerId - the Id of the PoolProcessorEnabler

poolProcessorId - the Id of the PoolProcessor

Throws:

NotFoundException - poolProcessorEnablerId or poolProcessorId not found or poolProcessorEnablerId already applied to poolProcessorId

NullArgumentException - poolProcessorEnablerId or poolProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequencePoolProcessorEnablers

boolean canSequencePoolProcessorEnablers()

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

Compliance:

mandatory - This method must be implemented.

movePoolProcessorEnablerAhead

void movePoolProcessorEnablerAhead(Id poolProcessorEnablerId,
 Id poolProcessorId,
 Id referenceId)
                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

poolProcessorEnablerId - the Id of the PoolProcessorEnabler

poolProcessorId - the Id of the PoolProcessor

referenceId - the reference pool processor enabler Id

Throws:

NotFoundException - poolProcessorEnablerId poolProcessorId, or referenceId not found or, poolProcessorEnablerId or referenceId not related to poolProcessorId

NullArgumentException - poolProcessorEnablerId, poolProcessorId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

movePoolProcessorEnablerBehind

void movePoolProcessorEnablerBehind(Id poolProcessorEnablerId,
 Id poolProcessorId,
 Id referenceId)
                             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

poolProcessorEnablerId - the Id of the PoolProcessorEnabler

poolProcessorId - the Id of the PoolProcessor

referenceId - the reference pool processor Id

Throws:

NotFoundException - poolProcessorEnablerId poolProcessorId, or referenceId not found or, poolProcessorEnablerId or referenceId not related to poolProcessorId

NullArgumentException - poolProcessorEnablerId, poolProcessorId, or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderPoolProcessorEnablers

void orderPoolProcessorEnablers(Id[] poolProcessorEnablerIds,
 Id poolProcessorId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

poolProcessorEnablerIds - the Ids for a set of PoolProcessorEnablers

poolProcessorId - the Id of the PoolProcessor

Throws:

NotFoundException - poolProcessorId not found or, a poolProcessorEnablerId not related to poolProcessorId

NullArgumentException - poolProcessorEnablerIds or poolProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.