atg.process.expression

Interface MutableExpression

All Superinterfaces:

Expression

public interface MutableExpression
extends Expression

An Expression that can be modified.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
static int	OPERATOR_ADD
static int	OPERATOR_APPEND
static int	OPERATOR_APPEND_ALL
static int	OPERATOR_APPEND_ONCE
static int	OPERATOR_ASSIGN
static int	OPERATOR_SUBTRACT

Method Summary

Modifier and Type	Method and Description
void	modifyValue(ProcessExecutionContext pContext, int pOperator, java.lang.Object pModifierValue) Modifies the data pointed to by the expression, using the given process execution context to resolve the pointer.

Methods inherited from interface atg.process.expression.Expression

canGetValue, getValue

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

OPERATOR_ASSIGN

static final int OPERATOR_ASSIGN

See Also:

Constant Field Values

OPERATOR_APPEND

static final int OPERATOR_APPEND

See Also:

Constant Field Values

OPERATOR_APPEND_ONCE

static final int OPERATOR_APPEND_ONCE

See Also:

Constant Field Values

OPERATOR_APPEND_ALL

static final int OPERATOR_APPEND_ALL

See Also:

Constant Field Values

OPERATOR_ADD

static final int OPERATOR_ADD

See Also:

Constant Field Values

OPERATOR_SUBTRACT

static final int OPERATOR_SUBTRACT

See Also:

Constant Field Values

Method Detail

modifyValue

void modifyValue(ProcessExecutionContext pContext,
                 int pOperator,
                 java.lang.Object pModifierValue)
          throws ProcessException

Modifies the data pointed to by the expression, using the given process execution context to resolve the pointer. For example, if the expression represents a subject property, that property is modified in the subject pointed to by the context.

This method should be called only if the process execution context is known to contain all the information necessary to resolve and modify the expression (in other words, if Expression.canGetValue returns true).

Parameters:

pOperator - one of OPERATOR_ASSIGN, OPERATOR_APPEND, OPERATOR_APPEND_ONCE, OPERATOR_APPEND_ALL, OPERATOR_ADD, and OPERATOR_SUBTRACT; OPERATOR_APPEND, OPERATOR_APPEND_ONCE, and OPERATOR_APPEND_ALL should only be used if the expression evaluates to an array/List/Set; OPERATOR_ADD and OPERATOR_SUBTRACT should only be used if the expression evaluates to a Number

pModifierValue - the value used to modify the current value, according to the given operator; the type of the value should be compatible with the type of the evaluated expression and the operator

Throws:

ProcessException - if the expression could not be resolved, or the value could not be modified, for example because the given operator or modifier value is invalid for this expression