Function (Appian API)

java.lang.Object
- com.appiancorp.suiteapi.expression.Function

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Function>
```
public class Function
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable<Function>
```
This class represents a function in the Expression Editor.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Function()

Function(Function f)

Function(java.lang.String name)

Constructors
Constructor and Description
`Function()`
`Function(Function f)`
`Function(java.lang.String name)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addFunctionParameter(FunctionParameter parameter)` Adds a parameter to the function's parameters.
`int`	`compareTo(Function o)`
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getCategoryName()` Gets the name of the parent category for the function
`java.lang.String`	`getDescription()` Gets the description of the function
`java.lang.String`	`getDomain()` Returns the domain of this function.
`java.lang.String`	`getExternalDescription()` Gets the path to the external resource containing the description of the function.
`java.lang.String`	`getFullName()` Gets a name with both domain and name in it but only if `getDomain()` is not null or empty.
`FunctionParameter[]`	`getFunctionParameters()` Gets the parameters for the function
`java.lang.String`	`getI18nKey()`
`java.lang.String`	`getName()` Gets the unique name of the function
`java.lang.String`	`getOutputSystemTypename()` Return the outputTypename of the function.
`java.lang.String`	`getOutputType()`
`int`	`hashCode()`
`boolean`	`isHiddenFromAutosuggest()` Gets `true` or `false` depending on whether the function should be hidden from autosuggest
`boolean`	`isUnlimitedParameters()` Gets `true` or `false` depending on whether the function can have unlimited parameters
`void`	`setCategoryName(java.lang.String name)` Sets the name of the parent category for the function
`void`	`setDescription(java.lang.String description)` Sets the description of the function
`void`	`setDomain(java.lang.String domain)` Sets the domain of this function.
`void`	`setExternalDescription(java.lang.String externalDescription)` Sets the path to the external resource containing the description of the function.
`void`	`setFunctionParameters(FunctionParameter[] parameters)` Sets the parameters for the function
`void`	`setHiddenFromAutosuggest(boolean hiddenFromAutosuggest)` Sets `true` or `false` depending on whether the function should be hidden from autosuggest
`void`	`setI18nKey(java.lang.String i18nKey)`
`void`	`setName(java.lang.String name)` Sets the unique name of the function
`void`	`setOutputSystemTypename(java.lang.String outputSystemTypename)` Set the outputTypename of the function.
`void`	`setOutputType(java.lang.String outputType)`
`void`	`setUnlimitedParameters(boolean parameters)` Sets `true` or `false` depending on whether the function can have unlimited parameters
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Function
```
public Function()
```
  - Function
```
public Function(java.lang.String name)
```
  - Function
```
public Function(Function f)
```
- Method Detail
  - getCategoryName
```
public java.lang.String getCategoryName()
```
    Gets the name of the parent category for the function
    
    Returns:
    
    String name of parent category
  - setCategoryName
```
public void setCategoryName(java.lang.String name)
```
    Sets the name of the parent category for the function
    
    Parameters:
    
    name - String name of parent category
  - getDescription
```
public java.lang.String getDescription()
```
    Gets the description of the function
    
    Returns:
    
    String description of function
  - setDescription
```
public void setDescription(java.lang.String description)
```
    Sets the description of the function
    
    Parameters:
    
    description - String description of function
  - getExternalDescription
```
public java.lang.String getExternalDescription()
```
    Gets the path to the external resource containing the description of the function. The path must be relative to the root of the servlet context and begin with a '/'.
    An example of a valid path is
    /components/expeditor/functions/text.jsp
    
    Returns:
    
    path to the resource
  - setExternalDescription
```
public void setExternalDescription(java.lang.String externalDescription)
```
    Sets the path to the external resource containing the description of the function. The path must be relative to the root of the servlet context and begin with a '/'.
    An example of a valid path is
    /components/expeditor/functions/text.jsp
    
    Parameters:
    
    externalDescription - path to the resource
  - getFunctionParameters
```
public FunctionParameter[] getFunctionParameters()
```
    Gets the parameters for the function
    
    Returns:
    
    an array of FunctionParameter objects representing the parameters for the function
    
    See Also:
    
    FunctionParameter
  - setFunctionParameters
```
public void setFunctionParameters(FunctionParameter[] parameters)
```
    Sets the parameters for the function
    
    Parameters:
    
    parameters - an array of FunctionParameter objects representing the parameters to set for the function
    
    See Also:
    
    FunctionParameter
  - addFunctionParameter
```
public void addFunctionParameter(FunctionParameter parameter)
```
    Adds a parameter to the function's parameters.
    
    Parameters:
    
    parameter - The parameter to add.
  - getName
```
public java.lang.String getName()
```
    Gets the unique name of the function
    
    Returns:
    
    Unique String name of function
  - getFullName
```
public java.lang.String getFullName()
```
    Gets a name with both domain and name in it but only if getDomain() is not null or empty. Otherwise, this returns the same as getName() returns.
  - setName
```
public void setName(java.lang.String name)
```
    Sets the unique name of the function
    
    Parameters:
    
    name - Unique String name of function
  - getDomain
```
public java.lang.String getDomain()
```
    Returns the domain of this function. The domain qualifies the name of the function. The syntax is domain!name. Domain examples are "fn", "pv", "a", etc.
  - setDomain
```
public void setDomain(java.lang.String domain)
```
    Sets the domain of this function. This value cannot be updated on the server.
  - isUnlimitedParameters
```
public boolean isUnlimitedParameters()
```
    Gets true or false depending on whether the function can have unlimited parameters
    
    Returns:
    
    true or false if function can have unlimited parameters or not
  - setUnlimitedParameters
```
public void setUnlimitedParameters(boolean parameters)
```
    Sets true or false depending on whether the function can have unlimited parameters
    
    Parameters:
    
    parameters - true or false if function can have unlimited parameters or not
  - getOutputType
```
public java.lang.String getOutputType()
```
  - setOutputType
```
public void setOutputType(java.lang.String outputType)
```
  - getI18nKey
```
public java.lang.String getI18nKey()
```
  - setI18nKey
```
public void setI18nKey(java.lang.String i18nKey)
```
  - isHiddenFromAutosuggest
```
public boolean isHiddenFromAutosuggest()
```
    Gets true or false depending on whether the function should be hidden from autosuggest
  - setHiddenFromAutosuggest
```
public void setHiddenFromAutosuggest(boolean hiddenFromAutosuggest)
```
    Sets true or false depending on whether the function should be hidden from autosuggest
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - compareTo
```
public int compareTo(Function o)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<Function>
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    String for debugging purposes
  - getOutputSystemTypename
```
public java.lang.String getOutputSystemTypename()
```
    Return the outputTypename of the function.
    
    Returns:
    
    the outputTypename of the function
  - setOutputSystemTypename
```
public void setOutputSystemTypename(java.lang.String outputSystemTypename)
```
    Set the outputTypename of the function. This attribute is not required and it is mutually exclusive with outputType. Use the outputTypename instead of the outputType if the output type is not a built-in system type like Integer or String. Setting the outputTypeName triggers retrieving the actual type from the outputTypename and setting the outputType attribute.
    
    Parameters:
    
    outputTypename -
    
    See Also:
    
    AppianType

Class Function

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Function

Function

Function

Method Detail

getCategoryName

setCategoryName

getDescription

setDescription

getExternalDescription

setExternalDescription

getFunctionParameters

setFunctionParameters

addFunctionParameter

getName

getFullName

setName

getDomain

setDomain

isUnlimitedParameters

setUnlimitedParameters

getOutputType

setOutputType

getI18nKey

setI18nKey

isHiddenFromAutosuggest

setHiddenFromAutosuggest

hashCode

equals

compareTo

toString

getOutputSystemTypename

setOutputSystemTypename