Package com.appiancorp.suiteapi.expression

Class FunctionParameter

java.lang.Object
com.appiancorp.suiteapi.expression.FunctionParameter
All Implemented Interfaces:
Serializable
public class FunctionParameter extends Object implements Serializable

This class represents a parameter of a function in the Expression Editor. The attributes type and typename are mutually exclusive. Typename is used to reference types that are not base primitive types with a known id.

See Also:

  • Constructor Details

    • FunctionParameter

      public FunctionParameter()

    • FunctionParameter

      public FunctionParameter(FunctionParameter fp)

    • FunctionParameter

      public FunctionParameter(Method method, int methodParameterIndex, Name name, Parameter param, int type)
      Create a FunctionParameter using a type id. Use this constructor when the parameter type is a built-in system type such as Integer or String.
      See Also:

    • FunctionParameter

      public FunctionParameter(Method method, int methodParameterIndex, Name name, Parameter param, String systemTypename)
      Create a FunctionParameter using a name for the type of the parameter instead of a type id. Use this contructor when the parameter type is not a built-in system type like Integer or Text.
      See Also:

  • Method Details

    • getDescription

      public String getDescription()
      Gets the description of parameter
      Returns:
      the string description of the parameter

    • setDescription

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

    • getName

      public String getName()
      Gets the name of parameter
      Returns:
      the name of the parameter

    • setName

      public void setName(String name)
      Sets the name of parameter
      Parameters:
      name - the name of parameter

    • isRequired

      public boolean isRequired()
      Indicates whether the parameter is required as an input to the function
      Returns:
      true or false if the parameter is required or not.

    • setRequired

      public void setRequired(boolean required)
      Sets whether the parameter is required as an input to the function
      Parameters:
      required - true or false if the parameter is required or not.

    • getType

      public int getType()
      Gets the Type of the parameter. This will match one of the types in TypedVariable
      Returns:
      the Type of the parameter
      See Also:

    • setType

      public void setType(int type)
      Sets the Type of the parameter. This must match one of the types in TypedVariable
      Parameters:
      type - the Type of the parameter
      See Also:

    • getSystemTypename

      public String getSystemTypename()
      Gets the Typename of the parameter. This value is empty is the type was provided using its ID.
      Returns:
      The Typename of the parameter

    • setSystemTypename

      public void setSystemTypename(String systemTypename)
      Sets the Typename of the parameter.

    • isUnlimited

      public boolean isUnlimited()
      Indicates whether this parameter may have an unlimited number of entries.

    • setUnlimited

      public void setUnlimited(boolean isUnlimited)
      Sets whether this function parameter can take an unlimited number of entries. This value cannot be updated on the server.
      See Also:

    • isTranslatable

      public boolean isTranslatable()
      Indicates whether this function parameter is translatable or not.

    • setTranslatable

      public void setTranslatable(boolean translatable)
      Sets whether this function parameter is translatable or not.
      See Also:

    • getEnumeration

      public String getEnumeration()
      Gets the enumeration name for this parameter.
      Returns:
      the enumeration name, or null if no enumeration is specified

    • setEnumeration

      public void setEnumeration(String enumeration)
      Sets the enumeration name for this parameter.
      Parameters:
      enumeration - the enumeration name, or null for no enumeration

    • toString

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

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