Interface ParameterProcessorEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ParameterProcessorEnablerRuleApplicationSession
extends OsidSession

This session provides methods to apply ParameterProcessorEnablers to ParameterProcessors . A ParameterProcessor with multiple ParameterProcessorEnablers means any positive rule evaluation across the enablers result in an effective ParameterProcessor .

Method Summary

Modifier and Type	Method	Description
void	assignParameterProcessorEnablerToParameterProcessor(Id parameterProcessorEnablerId, Id parameterProcessorId)	Adds an existing ParameterProcessorEnabler to a ParameterProcessor .
boolean	canAssignParameterProcessorEnablers()	Tests if this user can alter parameter processor enabler/parameter processor mappings.
boolean	canSequenceParameterProcessorEnablers()	Tests if this user can order ParametereProcessorEnablers .
Configuration	getConfiguration()	Gets the Configuration associated with this session.
Id	getConfigurationId()	Gets the Configuration Id associated with this session.
void	moveParameterProcessorEnablerAhead(Id parameterProcessorEnablerId, Id parameterEnablerId, Id referenceId)	Reorders parameter processor enablers for a parameter processor by moving the specified parameter processor enabler in front of a reference parameter enabler.
void	moveParameterProcessorEnablerBehind(Id parameterProcessorEnablerId, Id parameterEnablerId, Id referenceId)	Reorders parameter processor enablers for a parameter by moving the specified parameter processor enabler behind a reference parameter processor enabler.
void	orderParameterProcessorEnablers(Id[] parameterProcessorEnablerIds, Id parameterProcessorId)	Reorders a set of parameter processor enablers for a parameter processor.
void	unassignParameterProcessorEnablerFromParameterProcessor(Id parameterProcessorEnablerId, Id parameterProcessorId)	Removes a ParameterProcessorEnabler from a ParameterProcessor .

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

getConfigurationId

Id getConfigurationId()

Gets the Configuration Id associated with this session.

Returns:

the Configuration Id associated with this session

Compliance:

mandatory - This method must be implemented.

getConfiguration

Configuration getConfiguration()
                        throws OperationFailedException,
PermissionDeniedException

Gets the Configuration associated with this session.

Returns:

the configuration

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAssignParameterProcessorEnablers

boolean canAssignParameterProcessorEnablers()

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

assignParameterProcessorEnablerToParameterProcessor

void assignParameterProcessorEnablerToParameterProcessor(Id parameterProcessorEnablerId,
 Id parameterProcessorId)
                                                  throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing ParameterProcessorEnabler to a ParameterProcessor .

Parameters:

parameterProcessorEnablerId - the Id of the ParameterProcessorEnabler

parameterProcessorId - the Id of the ParameterProcessor

Throws:

AlreadyExistsException - parameterProcessorEnablerId is already applied to parameterProcessorId

NotFoundException - parameterProcessorEnablerId or parameterProcessorId not found

NullArgumentException - parameterProcessorEnablerId or parameterProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignParameterProcessorEnablerFromParameterProcessor

void unassignParameterProcessorEnablerFromParameterProcessor(Id parameterProcessorEnablerId,
 Id parameterProcessorId)
                                                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a ParameterProcessorEnabler from a ParameterProcessor .

Parameters:

parameterProcessorEnablerId - the Id of the ParameterProcessorEnabler

parameterProcessorId - the Id of the ParameterProcessor

Throws:

NotFoundException - parameterProcessorEnablerId or parameterProcessorId not found or parameterProcessorEnablerId is not applied to parameterProcessorId

NullArgumentException - parameterProcessorEnablerId or parameterProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceParameterProcessorEnablers

boolean canSequenceParameterProcessorEnablers()

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

Compliance:

mandatory - This method must be implemented.

moveParameterProcessorEnablerAhead

void moveParameterProcessorEnablerAhead(Id parameterProcessorEnablerId,
 Id parameterEnablerId,
 Id referenceId)
                                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

parameterProcessorEnablerId - the Id of a ParameterProcessorEnabler

parameterEnablerId - the Id of a ParameterProcessor

referenceId - the reference parameter processor enabler Id

Throws:

NotFoundException - parameterProcessorEnablerId, parameterEnablerId , or referenceId not found or, parameterProcessorEnablerId , or referenceId not related to parameterEnablerId

NullArgumentException - parameterProcessorEnablerId, parameterEnablerId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveParameterProcessorEnablerBehind

void moveParameterProcessorEnablerBehind(Id parameterProcessorEnablerId,
 Id parameterEnablerId,
 Id referenceId)
                                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

parameterProcessorEnablerId - the Id of a ParameterProcessorEnabler

parameterEnablerId - the Id of a ParameterProcessor

referenceId - the reference parameter processor enabler Id

Throws:

NotFoundException - parameterProcessorEnablerId, parameterEnablerId , or referenceId not found or, parameterProcessorEnablerId , or referenceId not related to parameterEnablerId

NullArgumentException - parameterProcessorEnablerId, parameterEnablerId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderParameterProcessorEnablers

void orderParameterProcessorEnablers(Id[] parameterProcessorEnablerIds,
 Id parameterProcessorId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

parameterProcessorEnablerIds - the Ids for a set of ParameterProcessorEnablers

parameterProcessorId - the Id of a ParameterProcessor

Throws:

NotFoundException - parameterProcessorId not found or, a parameterProcessorEnablerId not related to parameterProcessorId

NullArgumentException - parameterProcessorEnablerIds or parameterProcessorId , is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.