Package com.orchestranetworks.addon.dqid

Class ParameterDefinition

java.lang.Object
com.orchestranetworks.addon.dqid.ParameterDefinition
public final class ParameterDefinition extends Object
The definition of an Indicator input or output parameter.
See Also:

  • Constructor Details

    • ParameterDefinition

      public ParameterDefinition(String name, com.orchestranetworks.schema.SchemaTypeName type, com.onwbp.base.text.UserMessage label, com.onwbp.base.text.UserMessage description, boolean visibleOnDashboard)
      TODO A parameter definition without a default value and selected output parameters can be displayed on a dashboard.
      Since:
      2.5.0

    • ParameterDefinition

      public ParameterDefinition(String name, com.orchestranetworks.schema.SchemaTypeName type, com.onwbp.base.text.UserMessage label, com.onwbp.base.text.UserMessage description)
      A simple parameter definition without a default value.
      Since:
      1.4.0

    • ParameterDefinition

      public ParameterDefinition(String name, com.orchestranetworks.schema.SchemaTypeName type, com.onwbp.base.text.UserMessage label, com.onwbp.base.text.UserMessage description, String defaultValue)
      A simple parameter definition with a default value.
      Since:
      1.4.0

    • ParameterDefinition

      public ParameterDefinition(String name, com.orchestranetworks.schema.SchemaTypeName type, com.onwbp.base.text.UserMessage label, com.onwbp.base.text.UserMessage description, ListConstraint listConstraint)
      A parameter definition with a list of values.
      Since:
      1.3.0
      See Also:

    • ParameterDefinition

      public ParameterDefinition(String name, com.orchestranetworks.schema.SchemaTypeName type, com.onwbp.base.text.UserMessage label, com.onwbp.base.text.UserMessage description, ListConstraint listConstraint, HTMLComponent htmlComponent)
      A parameter definition with a list of values and a UI component type.
      Since:
      1.4.0
      See Also:

  • Method Details

    • getName

      public String getName()
      Returns the name of the parameter.

    • getType

      public com.orchestranetworks.schema.SchemaTypeName getType()
      Returns SchemaTypeName of the parameter.

    • getLabel

      public com.onwbp.base.text.UserMessage getLabel()
      Returns the label of the parameter.

    • getDescription

      public com.onwbp.base.text.UserMessage getDescription()
      Returns the description of the parameter.

    • getDefaultValue

      public String getDefaultValue()
      Returns the predefined value of the parameter if isList() returns false.

    • setGraphicalOptions

      public void setGraphicalOptions(GraphicalOptions graphicalOptions)
      See Also:

    • getGraphicalOptions

      public GraphicalOptions getGraphicalOptions()
      See Also:

    • isList

      public boolean isList()
      Returns true if the definition is a multiple-occurrenced or enumeration type.
      Since:
      1.3.0

    • getMinOccurs

      public int getMinOccurs()
      Returns 1 if isList() returns false.
      Since:
      1.3.0
      See Also:

    • getMaxOccurs

      public int getMaxOccurs()
      Returns 1 if isList() returns false.
      Since:
      1.3.0
      See Also:

    • getDefaultValues

      @Deprecated public List<String> getDefaultValues()
      Deprecated.
      As of v1.4.0, replaced by getDefaultPredefinedValues().
      Returns an empty list if isList() returns false.
      Since:
      1.3.0

    • getDefaultPredefinedValues

      public Set<PredefinedValue> getDefaultPredefinedValues()
      Returns an empty list if isList() returns false.
      Since:
      1.4.0
      See Also:

    • getHTMLComponent

      public HTMLComponent getHTMLComponent()
      Returns the HTML Component that represents the parameter.
      Since:
      1.4.0
      See Also:

    • isUndefinedValueSupported

      public boolean isUndefinedValueSupported()
      Returns true if the data type is Boolean, and it allows an undefined value.

      Since v1.4.0, it is the recommendation to use ParameterConstraint instead.

      Since:
      1.3.0

    • setUndefinedValueSupported

      public void setUndefinedValueSupported(boolean undefinedValueSupported)
      The property is used for the Boolean data type.

      Since v1.4.0, it is the recommendation to use ParameterConstraint instead.

      Parameters:
      undefinedValueSupported - boolean
      Since:
      1.3.0

    • isNegativeSupported

      public boolean isNegativeSupported()
      Returns true if the data type is Number, and it allows a negative number.

      Since v1.4.0, it is the recommendation to use ParameterConstraint instead.

      Since:
      1.3.0

    • setNegativeSupported

      public void setNegativeSupported(boolean negativeSupported)
      The property is used if the data type is Number.

      Since v1.4.0, it is the recommendation to use ParameterConstraint instead.

      Parameters:
      negativeSupported - boolean
      Since:
      1.3.0

    • getParameterConstraint

      public ParameterConstraint getParameterConstraint()
      Returns the parameter constraint.
      Since:
      1.4.0
      See Also:

    • setParameterConstraint

      public void setParameterConstraint(ParameterConstraint parameterConstraint)
      Defines the parameter constraint.
      Since:
      1.4.0
      See Also:

    • getListConstraint

      public ListConstraint getListConstraint()
      Returns the list constraint.
      Since:
      1.4.0
      See Also:

    • isVisibleOnDashboard

      public boolean isVisibleOnDashboard()

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

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