Package com.orchestranetworks.addon.dpra.function

Class OutputDefinition

java.lang.Object
com.orchestranetworks.addon.dpra.function.OutputDefinition
public final class OutputDefinition extends Object
Specifies the output definition of a function.
Since:
4.2.0
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    static OutputDefinition
    forBoolean(String name, com.onwbp.base.text.UserMessage label, com.onwbp.base.text.UserMessage description)
    Creates an instance of boolean output.
    static OutputDefinition
    forDateTime(String name, com.onwbp.base.text.UserMessage label, com.onwbp.base.text.UserMessage description)
    Creates an instance of date time output.
    static OutputDefinition
    forDecimal(String name, com.onwbp.base.text.UserMessage label, com.onwbp.base.text.UserMessage description)
    Creates an instance of decimal output.
    static OutputDefinition
    forInteger(String name, com.onwbp.base.text.UserMessage label, com.onwbp.base.text.UserMessage description)
    Creates an instance of integer output.
    static OutputDefinition
    forString(String name, com.onwbp.base.text.UserMessage label, com.onwbp.base.text.UserMessage description)
    Creates an instance of string output.
    com.orchestranetworks.schema.SchemaTypeName
    getDataType()
    Return the data type.
    com.onwbp.base.text.UserMessage
    getDescription()
    Returns the output definition description.
    com.onwbp.base.text.UserMessage
    getLabel()
    Returns the output definition label.
    String
    getName()
    Returns the unique name.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Method Details

    • forBoolean

      public static OutputDefinition forBoolean(String name, com.onwbp.base.text.UserMessage label, com.onwbp.base.text.UserMessage description)
      Creates an instance of boolean output.
      Parameters:
      name - The unique name of the output.
      label - The localized label.
      description - The localized description.

    • forDateTime

      public static OutputDefinition forDateTime(String name, com.onwbp.base.text.UserMessage label, com.onwbp.base.text.UserMessage description)
      Creates an instance of date time output.
      Parameters:
      name - The unique name of the output.
      label - The localized label.
      description - The localized description.

    • forDecimal

      public static OutputDefinition forDecimal(String name, com.onwbp.base.text.UserMessage label, com.onwbp.base.text.UserMessage description)
      Creates an instance of decimal output.
      Parameters:
      name - The unique name of the output.
      label - The localized label.
      description - The localized description.

    • forInteger

      public static OutputDefinition forInteger(String name, com.onwbp.base.text.UserMessage label, com.onwbp.base.text.UserMessage description)
      Creates an instance of integer output.
      Parameters:
      name - The unique name of the output.
      label - The localized label.
      description - The localized description.

    • forString

      public static OutputDefinition forString(String name, com.onwbp.base.text.UserMessage label, com.onwbp.base.text.UserMessage description)
      Creates an instance of string output.
      Parameters:
      name - The unique name of the output.
      label - The localized label.
      description - The localized description.

    • getName

      public String getName()
      Returns the unique name.

    • getLabel

      public com.onwbp.base.text.UserMessage getLabel()
      Returns the output definition label.

    • getDescription

      public com.onwbp.base.text.UserMessage getDescription()
      Returns the output definition description.

    • getDataType

      public com.orchestranetworks.schema.SchemaTypeName getDataType()
      Return the data type.