Package com.orchestranetworks.addon.dqid
Class ParameterDefinition
- java.lang.Object
-
- com.orchestranetworks.addon.dqid.ParameterDefinition
-
public final class ParameterDefinition extends java.lang.Object
The definition of anIndicator
input or output parameter.
-
-
Constructor Summary
Constructors Constructor Description ParameterDefinition(java.lang.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(java.lang.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(java.lang.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(java.lang.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(java.lang.String name, com.orchestranetworks.schema.SchemaTypeName type, com.onwbp.base.text.UserMessage label, com.onwbp.base.text.UserMessage description, java.lang.String defaultValue)
A simple parameter definition with a default value.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
java.util.Set<PredefinedValue>
getDefaultPredefinedValues()
Returns an empty list ifisList()
returnsfalse
.java.lang.String
getDefaultValue()
Returns the predefined value of the parameter ifisList()
returnsfalse
.java.util.List<java.lang.String>
getDefaultValues()
Deprecated.As of v1.4.0, replaced bygetDefaultPredefinedValues()
.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()
int
getMinOccurs()
java.lang.String
getName()
Returns the name of the parameter.ParameterConstraint
getParameterConstraint()
Returns the parameter constraint.com.orchestranetworks.schema.SchemaTypeName
getType()
ReturnsSchemaTypeName
of the parameter.int
hashCode()
boolean
isList()
Returnstrue
if the definition is a multiple-occurrenced or enumeration type.boolean
isNegativeSupported()
Returnstrue
if the data type is Number, and it allows a negative number.boolean
isUndefinedValueSupported()
Returnstrue
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.
-
-
-
Constructor Detail
-
ParameterDefinition
public ParameterDefinition(java.lang.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(java.lang.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(java.lang.String name, com.orchestranetworks.schema.SchemaTypeName type, com.onwbp.base.text.UserMessage label, com.onwbp.base.text.UserMessage description, java.lang.String defaultValue)
A simple parameter definition with a default value.- Since:
- 1.4.0
-
ParameterDefinition
public ParameterDefinition(java.lang.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(java.lang.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 java.lang.String getName()
Returns the name of the parameter.
-
getType
public com.orchestranetworks.schema.SchemaTypeName getType()
ReturnsSchemaTypeName
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 java.lang.String getDefaultValue()
Returns the predefined value of the parameter ifisList()
returnsfalse
.
-
setGraphicalOptions
public void setGraphicalOptions(GraphicalOptions graphicalOptions)
- See Also:
GraphicalOptions
-
getGraphicalOptions
public GraphicalOptions getGraphicalOptions()
- See Also:
GraphicalOptions
-
isList
public boolean isList()
Returnstrue
if the definition is a multiple-occurrenced or enumeration type.- Since:
- 1.3.0
-
getMinOccurs
public int getMinOccurs()
- Since:
- 1.3.0
- See Also:
ListConstraint.getMinOccurs()
-
getMaxOccurs
public int getMaxOccurs()
- Since:
- 1.3.0
- See Also:
ListConstraint.getMaxOccurs()
-
getDefaultValues
@Deprecated public java.util.List<java.lang.String> getDefaultValues()
Deprecated.As of v1.4.0, replaced bygetDefaultPredefinedValues()
.Returns an empty list ifisList()
returnsfalse
.- Since:
- 1.3.0
-
getDefaultPredefinedValues
public java.util.Set<PredefinedValue> getDefaultPredefinedValues()
Returns an empty list ifisList()
returnsfalse
.- 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()
Returnstrue
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()
Returnstrue
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 classjava.lang.Object
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
-