com.appiancorp.suiteapi.expression

Class PartialResult

java.lang.Object

com.appiancorp.suiteapi.expression.PartialResult

All Implemented Interfaces:

AppianTypeHolder, java.io.Serializable

public class PartialResult
extends java.lang.Object
implements java.io.Serializable, AppianTypeHolder

This class represents the partial evaluation of a function in the Expression Editor, as well as the result of that evaluation.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PartialResult()

Method Summary

Modifier and Type	Method and Description
void	fillInAppianTypes(AppianTypeCache cache_) If the implementing class references any Appian-typed objects (such as User, Group, Folder), this method should be implemented to put the primary keys of these objects in the given cache.
java.lang.String	getAssignmentOperator() Gets the assignment operator Supported operators are: : Direct Modification +: Addition Modification -: Subtraction Modification *: Multiplication Modification /: Division Modification ^: Exponentiation Modification &: Concatenation Modification
java.lang.String	getAssignmentVariable() Gets the assignment variable.
java.lang.String	getFunction() Gets the name of the function
TypedVariable[]	getFunctionParameters() Gets the function parameters
TypedVariable	getResult() Gets the partial result
void	setAssignmentOperator(java.lang.String operator_) Sets the assignment operator Allowed operators are: : Direct Modification +: Addition Modification -: Subtraction Modification *: Multiplication Modification /: Division Modification ^: Exponentiation Modification &: Concatenation Modification
void	setAssignmentVariable(java.lang.String variable_) Sets assignment variable.
void	setFunction(java.lang.String function_) Sets the name of the function
void	setFunctionParameters(TypedVariable[] parameters_) Sets the function parameters
void	setResult(TypedVariable result_) Sets the partial result
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PartialResult

public PartialResult()

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

the function

getAssignmentOperator

public java.lang.String getAssignmentOperator()

Gets the assignment operator Supported operators are:
: Direct Modification
+: Addition Modification
-: Subtraction Modification
*: Multiplication Modification
/: Division Modification
^: Exponentiation Modification
&: Concatenation Modification

Returns:

String assignment operator

setAssignmentOperator

public void setAssignmentOperator(java.lang.String operator_)

Sets the assignment operator Allowed operators are:
: Direct Modification
+: Addition Modification
-: Subtraction Modification
*: Multiplication Modification
/: Division Modification
^: Exponentiation Modification
&: Concatenation Modification

Parameters:

operator_ - String assignment operator

getAssignmentVariable

public java.lang.String getAssignmentVariable()

Gets the assignment variable. This is the string that appears before the assignment operator and is the variable that will be assigned the value returned by the expression. E.g. a:1+2, a is the assignment variable, : the assignment operator and a will be set to be 3.

Returns:

the assignment variable

setAssignmentVariable

public void setAssignmentVariable(java.lang.String variable_)

Sets assignment variable. This is the string that appears before the assignment operator and is the variable that will be assigned the value returned by the expression. E.g. a:1+2, a is the assignment variable, : the assignment operator and a will be set to be 3.

Parameters:

variable_ - String assignment variable

getFunction

public java.lang.String getFunction()

Gets the name of the function

Returns:

the name of the function

setFunction

public void setFunction(java.lang.String function_)

Sets the name of the function

Parameters:

function_ - the name of the function

getFunctionParameters

public TypedVariable[] getFunctionParameters()

Gets the function parameters

Returns:

array of TypedVariable function parameters

See Also:

TypedVariable

setFunctionParameters

public void setFunctionParameters(TypedVariable[] parameters_)

Sets the function parameters

Parameters:

parameters_ - array of TypedVariable function parameters

See Also:

TypedVariable

getResult

public TypedVariable getResult()

Gets the partial result

Returns:

the partial result as a TypedVariable

See Also:

TypedVariable

setResult

public void setResult(TypedVariable result_)

Sets the partial result

Parameters:

result_ - the partial result as a TypedVariable

See Also:

TypedVariable

fillInAppianTypes

public void fillInAppianTypes(AppianTypeCache cache_)

Description copied from interface: AppianTypeHolder

If the implementing class references any Appian-typed objects (such as User, Group, Folder), this method should be implemented to put the primary keys of these objects in the given cache. Later, the cache will populate itself with the display strings that correspond to all of its ids, such as "Human Resources" for group 9.

Specified by:

fillInAppianTypes in interface AppianTypeHolder

Parameters:

cache_ - cache of Appian-typed objects.