Package com.appiancorp.suiteapi.expression

Class Function

java.lang.Object
com.appiancorp.suiteapi.expression.Function
All Implemented Interfaces:
Serializable, Comparable<Function>
public class Function extends Object implements Serializable, Comparable<Function>
This class represents a function in the Expression Editor.
See Also:

  • Constructor Details

    • Function

      public Function()

    • Function

      public Function(String name)

    • Function

      public Function(Function f)

  • Method Details

    • getCategoryName

      public String getCategoryName()
      Gets the name of the parent category for the function
      Returns:
      String name of parent category

    • setCategoryName

      public void setCategoryName(String name)
      Sets the name of the parent category for the function
      Parameters:
      name - String name of parent category

    • getDescription

      public String getDescription()
      Gets the description of the function
      Returns:
      String description of function

    • setDescription

      public void setDescription(String description)
      Sets the description of the function
      Parameters:
      description - String description of function

    • getExternalDescription

      public 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(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:

    • 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:

    • addFunctionParameter

      public void addFunctionParameter(FunctionParameter parameter)
      Adds a parameter to the function's parameters.
      Parameters:
      parameter - The parameter to add.

    • getName

      public String getName()
      Gets the unique name of the function
      Returns:
      Unique String name of function

    • getFullName

      public 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(String name)
      Sets the unique name of the function
      Parameters:
      name - Unique String name of function

    • getDomain

      public 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(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 String getOutputType()

    • setOutputType

      public void setOutputType(String outputType)

    • getI18nKey

      public String getI18nKey()

    • setI18nKey

      public void setI18nKey(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

    • isTranslatableParameters

      public boolean isTranslatableParameters()
      Gets true or false depending on whether the function can have translatable parameters
      Returns:
      true or false if function can have translatable parameters or not

    • setTranslatableParameters

      public void setTranslatableParameters(boolean translatableParameters)
      Sets true or false depending on whether the function can have translatable parameters
      Parameters:
      parameters - true or false if function can have translatable parameters or not

    • isHiddenFromDocumentation

      public boolean isHiddenFromDocumentation()
      Gets true or false depending on whether the function should display documentation

    • setHiddenFromDocumentation

      public void setHiddenFromDocumentation(boolean hiddenFromDocumentation)
      Sets true or false depending on whether the function should display documentation

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • compareTo

      public int compareTo(Function o)
      Specified by:
      compareTo in interface Comparable<Function>

    • toString

      public String toString()
      Overrides:
      toString in class Object
      Returns:
      String for debugging purposes

    • getOutputSystemTypename

      public String getOutputSystemTypename()
      Return the outputTypename of the function.
      Returns:
      the outputTypename of the function

    • setOutputSystemTypename

      public void setOutputSystemTypename(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: