ParameterDefinition (EBX® Add-ons Version 5.3.4 Java API)

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:

IndicatorDefinition.getInputParametersDefinition(), IndicatorDefinition.getOutputParametersDefinition(), LinkedRecordDefinition.addOption(ParameterDefinition)

Constructor Summary

Constructors
Constructor and Description
`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.
`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.
`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.
`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.
`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.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Set<PredefinedValue>`	`getDefaultPredefinedValues()` Returns an empty list if `isList()` returns `false`.
`String`	`getDefaultValue()` Returns the predefined value of the parameter if `isList()` returns `false`.
`List<String>`	`getDefaultValues()` Deprecated. As of v1.4.0, replaced by `getDefaultPredefinedValues()`.
`com.onwbp.base.text.UserMessage`	`getDescription()` Returns the description of the parameter.
`GraphicalOptions`	`getGraphicalOptions()`
`HTMLComponent`	`getHTMLComponent()` Returns the HTML Component that represents the parameter.
`com.onwbp.base.text.UserMessage`	`getLabel()` Returns the label of the parameter.
`ListConstraint`	`getListConstraint()` Returns the list constraint.
`int`	`getMaxOccurs()` Returns `1` if `isList()` returns `false`.
`int`	`getMinOccurs()` Returns `1` if `isList()` returns `false`.
`String`	`getName()` Returns the name of the parameter.
`ParameterConstraint`	`getParameterConstraint()` Returns the parameter constraint.
`com.orchestranetworks.schema.SchemaTypeName`	`getType()` Returns `SchemaTypeName` of the parameter.
`int`	`hashCode()`
`boolean`	`isList()` Returns `true` if the definition is a multiple-occurrenced or enumeration type.
`boolean`	`isNegativeSupported()` Returns `true` if the data type is Number, and it allows a negative number.
`boolean`	`isUndefinedValueSupported()` Returns `true` if the data type is Boolean, and it allows an undefined value.
`boolean`	`isVisibleOnDashboard()`
`void`	`setGraphicalOptions(GraphicalOptions graphicalOptions)`
`void`	`setNegativeSupported(boolean negativeSupported)` The property is used if the data type is Number.
`void`	`setParameterConstraint(ParameterConstraint parameterConstraint)` Defines the parameter constraint.
`void`	`setUndefinedValueSupported(boolean undefinedValueSupported)` The property is used for the Boolean data type.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

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

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:: ListConstraint, HTMLComponent

Method Detail
- 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:
  
  GraphicalOptions
- getGraphicalOptions
```
public GraphicalOptions getGraphicalOptions()
```
  See Also:
  
  GraphicalOptions
- 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:
  
  ListConstraint.getMinOccurs()
- getMaxOccurs
```
public int getMaxOccurs()
```
  Returns 1 if isList() returns false.
  
  Since:
  
  1.3.0
  
  See Also:
  
  ListConstraint.getMaxOccurs()
- 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:
  
  ListConstraint.getDefaultPredefinedValues()
- getHTMLComponent
```
public HTMLComponent getHTMLComponent()
```
  Returns the HTML Component that represents the parameter.
  
  Since:
  
  1.4.0
  
  See Also:
  
  HTMLComponent
- 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:
  
  ParameterConstraint
- setParameterConstraint
```
public void setParameterConstraint(ParameterConstraint parameterConstraint)
```
  Defines the parameter constraint.
  
  Since:
  
  1.4.0
  
  See Also:
  
  ParameterConstraint
- getListConstraint
```
public ListConstraint getListConstraint()
```
  Returns the list constraint.
  
  Since:
  
  1.4.0
  
  See Also:
  
  ListConstraint
- isVisibleOnDashboard
```
public boolean isVisibleOnDashboard()
```
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class Object
- equals
```
public boolean equals(Object obj)
```
  Overrides:
  
  equals in class Object

EBX® Add-ons Version 5.3.4.

Copyright TIBCO Software Inc. 2001-2022. All rights reserved.
All third party product and company names and third party marks mentioned in this document are the property of their respective owners and are mentioned for identification.

Class ParameterDefinition

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ParameterDefinition

ParameterDefinition

ParameterDefinition

ParameterDefinition

ParameterDefinition

Method Detail

getName

getType

getLabel

getDescription

getDefaultValue

setGraphicalOptions

getGraphicalOptions

isList

getMinOccurs

getMaxOccurs

getDefaultValues

getDefaultPredefinedValues

getHTMLComponent

isUndefinedValueSupported

setUndefinedValueSupported

isNegativeSupported

setNegativeSupported

getParameterConstraint

setParameterConstraint

getListConstraint

isVisibleOnDashboard

hashCode

equals