Class FunctionRequest
java.lang.Object
com.appiancorp.suiteapi.expression.FunctionRequest
- All Implemented Interfaces:
Serializable
This class encapsulates a request by a user for a function to be evaluated.
- See Also:
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGets the domain that will be used to look up the function.Gets the unique id of expression needed so asynchronous calls can be madeGets the function name will be lower cased, as Interface is case insensitiveGets the function name together with the domain.Gets parameters that will be arguments to Java functionGets the type of server that the function request came from.void
Sets the domain that will be used to look up the function.void
setExpressionId
(Long id_) Sets the unique id of expression needed so asynchronous calls can be madevoid
setFunction
(String function_) Sets the function name will be lower cased, as Interface is case insensitivevoid
setFunctionParameters
(NamedTypedValue[] parameters_) Sets parameters that will be arguments to Java functionvoid
setOriginServerType
(Long originServerType_) Sets the type of server that the function request came from.static String
toFunctionString
(String _function, NamedTypedValue[] _functionParameters) static String
toFunctionString
(String domain, String _function, NamedTypedValue[] _functionParameters) Creates an Appian expression for the specified function and parameterstoString()
Returns the String representation of the Function Request object.
-
Field Details
-
FROM_EXECUTION
-
FROM_DESIGN
-
-
Constructor Details
-
FunctionRequest
public FunctionRequest()
-
-
Method Details
-
getExpressionId
Gets the unique id of expression needed so asynchronous calls can be made- Returns:
- Unique id of expression being evaluated by Java
-
setExpressionId
Sets the unique id of expression needed so asynchronous calls can be made- Parameters:
id_
- Unique id of expression
-
getFunction
Gets the function name will be lower cased, as Interface is case insensitive- Returns:
- String function name
-
setFunction
Sets the function name will be lower cased, as Interface is case insensitive- Parameters:
function_
- Function name
-
getDomain
Gets the domain that will be used to look up the function. Can be null or empty string, in which case, the fn! domain should be assumed- Returns:
- String domain to use
-
setDomain
Sets the domain that will be used to look up the function. Not setting this method, or setting a null or empty string will result in the fn! domain being assumed.- Parameters:
domain
- String domain
-
getFunctionNameWithDomain
Gets the function name together with the domain. The wildcard domain "all" will be ommitted from the result.- Returns:
- the String representation of the function name together with the domain in the standard domain!function format
-
getFunctionParameters
Gets parameters that will be arguments to Java function- Returns:
- function parameters with type and value
-
setFunctionParameters
Sets parameters that will be arguments to Java function- Parameters:
parameters_
- function parameters with type and value
-
getOriginServerType
Gets the type of server that the function request came from.- Returns:
- ServerType that the request came from.
-
setOriginServerType
Sets the type of server that the function request came from.- Parameters:
originServerType_
- type of server that request came from.
-
toFunctionString
-
toFunctionString
public static String toFunctionString(String domain, String _function, NamedTypedValue[] _functionParameters) Creates an Appian expression for the specified function and parameters- Parameters:
domain
- the domain of the function_function
- the name of the function_functionParameters
- - An array of function parameters- Returns:
- a String representation of the a function call in the expressions language
-
toString
Returns the String representation of the Function Request object. This will specify the function's Expression ID, context, function name and parameters.
-