Class PartialResult
java.lang.Object
com.appiancorp.suiteapi.expression.PartialResult
- All Implemented Interfaces:
AppianTypeHolder
,Serializable
This class represents the partial evaluation of a function in the Expression Editor, as well as the result of that evaluation.
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
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.Gets the assignment operator Supported operators are:
: Direct Modification
+: Addition Modification
-: Subtraction Modification
*: Multiplication Modification
/: Division Modification
^: Exponentiation Modification
&: Concatenation ModificationGets the assignment variable.Gets the name of the functionGets the function parametersGets the partial resultvoid
setAssignmentOperator
(String operator_) Sets the assignment operator Allowed operators are:
: Direct Modification
+: Addition Modification
-: Subtraction Modification
*: Multiplication Modification
/: Division Modification
^: Exponentiation Modification
&: Concatenation Modificationvoid
setAssignmentVariable
(String variable_) Sets assignment variable.void
setFunction
(String function_) Sets the name of the functionvoid
setFunctionParameters
(TypedVariable[] parameters_) Sets the function parametersvoid
setResult
(TypedVariable result_) Sets the partial resulttoString()
-
Constructor Details
-
PartialResult
public PartialResult()
-
-
Method Details
-
toString
-
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
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
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
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
Gets the name of the function- Returns:
- the name of the function
-
setFunction
Sets the name of the function- Parameters:
function_
- the name of the function
-
getFunctionParameters
Gets the function parameters- Returns:
- array of
TypedVariable
function parameters - See Also:
-
setFunctionParameters
Sets the function parameters- Parameters:
parameters_
- array ofTypedVariable
function parameters- See Also:
-
getResult
Gets the partial result- Returns:
- the partial result as a
TypedVariable
- See Also:
-
setResult
Sets the partial result- Parameters:
result_
- the partial result as aTypedVariable
- See Also:
-
fillInAppianTypes
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 interfaceAppianTypeHolder
- Parameters:
cache_
- cache of Appian-typed objects.
-