Interface ParameterProcessorRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ParameterProcessorRuleApplicationSession
extends OsidSession

This session provides methods to apply ParameterProcessors to Parameters .

Method Summary

Modifier and Type	Method	Description
void	assignParameterProcessorToParameter(Id parameterProcessorId, Id parameterId)	Adds an existing ParameterProcessor to a Parameter .
boolean	canAssignParameterProcessors()	Tests if this user can alter parameter processor/parameter mappings.
boolean	canSequenceParameterProcessors()	Tests if this user can order ParametereProcessors .
Configuration	getConfiguration()	Gets the Configuration associated with this session.
Id	getConfigurationId()	Gets the Configuration Id associated with this session.
void	moveParameterProcessorAhead(Id parameterProcessorId, Id parameterId, Id referenceId)	Reorders parameter processors for a parameter by moving the specified parameter processors in front of a reference parameter.
void	moveParameterProcessorBehind(Id parameterProcessorId, Id parameterId, Id referenceId)	Reorders parameter processors for a parameter by moving the specified parameter processor behind a reference parameter processor.
void	orderParameterProcessors(Id[] parameterProcessorIds, Id parameterId)	Reorders a set of parameter processors for a parameter.
void	unassignParameterProcessorFromParameter(Id parameterProcessorId, Id parameterId)	Removes a ParameterProcessor from a Parameter .

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.

canAssignParameterProcessors

boolean canAssignParameterProcessors()

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

assignParameterProcessorToParameter

void assignParameterProcessorToParameter(Id parameterProcessorId,
 Id parameterId)
                                  throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing ParameterProcessor to a Parameter .

Parameters:

parameterProcessorId - the Id of the ParameterProcessor

parameterId - the Id of the Parameter

Throws:

AlreadyExistsException - parameterProcessorId is already applied to parameterId

NotFoundException - parameterProcessorId or parameterId not found

NullArgumentException - parameterProcessorId or parameterId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignParameterProcessorFromParameter

void unassignParameterProcessorFromParameter(Id parameterProcessorId,
 Id parameterId)
                                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a ParameterProcessor from a Parameter .

Parameters:

parameterProcessorId - the Id of the ParameterProcessor

parameterId - the Id of the Parameter

Throws:

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

NullArgumentException - parameterProcessorId or parameterId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceParameterProcessors

boolean canSequenceParameterProcessors()

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

Compliance:

mandatory - This method must be implemented.

moveParameterProcessorAhead

void moveParameterProcessorAhead(Id parameterProcessorId,
 Id parameterId,
 Id referenceId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders parameter processors for a parameter by moving the specified parameter processors in front of a reference parameter.

Parameters:

parameterProcessorId - the Id of a ParameterProcessor

parameterId - the Id of a Parameter

referenceId - the reference parameter processor Id

Throws:

NotFoundException - parameterProcessorId, parameterId , or referenceId not found or, parameterProcessorId , or referenceId not related to parameterId

NullArgumentException - parameterProcessorId, parameterId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveParameterProcessorBehind

void moveParameterProcessorBehind(Id parameterProcessorId,
 Id parameterId,
 Id referenceId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

parameterProcessorId - the Id of a ParameterProcessor

parameterId - the Id of a Parameter

referenceId - the reference parameter processor Id

Throws:

NotFoundException - parameterProcessorId, parameterId , or referenceId not found or, parameterProcessorId , or referenceId not related to parameterId

NullArgumentException - parameterProcessorId, parameterId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderParameterProcessors

void orderParameterProcessors(Id[] parameterProcessorIds,
 Id parameterId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of parameter processors for a parameter.

Parameters:

parameterProcessorIds - the Ids for a set of ParameterProcessors

parameterId - the Id of a Parameter

Throws:

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

NullArgumentException - parameterProcessorIds or parameterId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.