Direct Known Subclasses:
FunctionInfo

public class FunctionProperties extends SchemaNamespaceProperties
The properties of a function - maps to CreateFunction.
  • Constructor Details

    • FunctionProperties

      public FunctionProperties()
      Constructor
  • Method Details

    • getInput_params

      public FunctionParameterInfos getInput_params()
      Return the description of the input parameters.
      Returns:
      list
    • setInput_params

      public void setInput_params(FunctionParameterInfos input_params)
      Set up the description of the input parameters,
      Parameters:
      input_params - list
    • getData_type

      public ColumnTypeName getData_type()
      Return the data type of the function ?
      Returns:
      enum
    • setData_type

      public void setData_type(ColumnTypeName data_type)
      Set up the data type of the function.
      Parameters:
      data_type - enum
    • getFull_data_type

      public String getFull_data_type()
      Return the "pretty-printed" function data type.
      Returns:
      string
    • setFull_data_type

      public void setFull_data_type(String full_data_type)
      Set up the "pretty-printed" function data type.
      Parameters:
      full_data_type - string
    • getReturn_params

      public FunctionParameterInfos getReturn_params()
      Return the description of the function's return parameters.
      Returns:
      parameter list
    • setReturn_params

      public void setReturn_params(FunctionParameterInfos return_params)
      Set up the description of the function's return parameters.
      Parameters:
      return_params - parameter list
    • getRoutine_body

      public RoutineBody getRoutine_body()
      Return the language of implementation. When **EXTERNAL** is used, the language of the routine function should be specified in the __external_language__ field, and the __return_params__ of the function cannot be used (as **TABLE** return type is not supported), and the __sql_data_access__ field must be **NO_SQL**.
      Returns:
      enum
    • setRoutine_body

      public void setRoutine_body(RoutineBody routine_body)
      Set up the language of implementation. When **EXTERNAL** is used, the language of the routine function should be specified in the __external_language__ field, and the __return_params__ of the function cannot be used (as **TABLE** return type is not supported), and the __sql_data_access__ field must be **NO_SQL**.
      Parameters:
      routine_body - enum
    • getRoutine_definition

      public String getRoutine_definition()
      Return the function body.
      Returns:
      string
    • setRoutine_definition

      public void setRoutine_definition(String routine_definition)
      Set up the function body.
      Parameters:
      routine_definition - string
    • getRoutine_dependencies

      public DependencyList getRoutine_dependencies()
      Return te list of dependencies.
      Returns:
      list
    • setRoutine_dependencies

      public void setRoutine_dependencies(DependencyList routine_dependencies)
      Set up the list of dependencies.
      Parameters:
      routine_dependencies - list
    • getParameter_style

      public ParameterStyle getParameter_style()
      Return the function parameter style. **S** is the value for SQL.
      Returns:
      enum
    • setParameter_style

      public void setParameter_style(ParameterStyle parameter_style)
      Set up the function parameter style. **S** is the value for SQL.
      Parameters:
      parameter_style - enum
    • getIs_deterministic

      public boolean getIs_deterministic()
      Return whether this function is deterministic.
      Returns:
      boolean
    • setIs_deterministic

      public void setIs_deterministic(boolean is_deterministic)
      Set up whether this function is deterministic.
      Parameters:
      is_deterministic - boolean
    • getSql_data_access

      public SQLDataAccess getSql_data_access()
      Return the type of SQL data access used by the function.
      Returns:
      enum
    • setSql_data_access

      public void setSql_data_access(SQLDataAccess sql_data_access)
      Set up the type of SQL data access used by the function.
      Parameters:
      sql_data_access - enum
    • getIs_null_call

      public boolean getIs_null_call()
      Return whether thi function is a null call,
      Returns:
      boolean
    • setIs_null_call

      public void setIs_null_call(boolean is_null_call)
      Set up whether this function is a null call.
      Parameters:
      is_null_call - boolean
    • getSecurity_type

      public SecurityType getSecurity_type()
      Return the function security type.
      Returns:
      enum
    • setSecurity_type

      public void setSecurity_type(SecurityType security_type)
      Set up the function security type.
      Parameters:
      security_type - enum
    • getSpecific_name

      public String getSpecific_name()
      Return the specific name of the function; Reserved for future use.
      Returns:
      string
    • setSpecific_name

      public void setSpecific_name(String specific_name)
      Set up the specific name of the function; Reserved for future use.
      Parameters:
      specific_name - string
    • getExternal_language

      public String getExternal_language()
      Return the name of the external language of the function (if relevant).
      Returns:
      string
    • setExternal_language

      public void setExternal_language(String external_language)
      Set up the name of the external language of the function (if relevant).
      Parameters:
      external_language - string
    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class SchemaNamespaceProperties
      Returns:
      print out of variables in a JSON-style
    • equals

      public boolean equals(Object objectToCompare)
      Compare the values of the supplied object with those stored in the current object.
      Overrides:
      equals in class SchemaNamespaceProperties
      Parameters:
      objectToCompare - supplied object
      Returns:
      boolean result of comparison
    • hashCode

      public int hashCode()
      Return hash code based on properties.
      Overrides:
      hashCode in class SchemaNamespaceProperties
      Returns:
      int