com.orchestranetworks.addon.daqa.cleansing

Class ParameterDefinition

java.lang.Object

com.orchestranetworks.addon.daqa.cleansing.ParameterDefinition

public final class ParameterDefinition
extends Object

Represents the definition of parameter for a cleansing procedure or cleansing operation.

Since:

1.5.0

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, ListConstraint listConstraint)
ParameterDefinition(String name, com.orchestranetworks.schema.SchemaTypeName type, com.onwbp.base.text.UserMessage label, com.onwbp.base.text.UserMessage description, String defaultValue)
ParameterDefinition(String name, com.onwbp.base.text.UserMessage label, com.onwbp.base.text.UserMessage description, String customSelection)
ParameterDefinition(String name, com.onwbp.base.text.UserMessage label, com.onwbp.base.text.UserMessage description, String htmlComponent, ListConstraint listConstraint, String defaultValue)

Method Summary

Modifier and Type	Method and Description
String	getCustomSelection() Returns the custom selection type of this parameter definition.
String	getDefaultValue() Returns the predefined value of a parameter if isList() is false.
List<String>	getDefaultValues() Returns an empty list if isList() is false.
com.onwbp.base.text.UserMessage	getDescription() Returns parameter's description.
String	getHTMLComponent() Returns HTMLComponent type of this parameter definition.
com.onwbp.base.text.UserMessage	getLabel() Returns a parameter's label.
int	getMaxOccurs() Returns 1 if isList() is false.
int	getMinOccurs() Returns 1 if isList() is false.
String	getName() Returns name of parameter.
com.orchestranetworks.schema.SchemaTypeName	getType() Returns a parameter's SchemaTypeName.
boolean	hasHTMLComponent() Returns true if current parameter definition has an HTML component.
boolean	isCustomSelection() Returns true if current parameter definition is a custom selection.
boolean	isList() Returns true if its definition is a multiple occurrence.

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterDefinition

public ParameterDefinition(String name,
                           com.onwbp.base.text.UserMessage label,
                           com.onwbp.base.text.UserMessage description,
                           String customSelection)

ParameterDefinition

public ParameterDefinition(String name,
                           com.orchestranetworks.schema.SchemaTypeName type,
                           com.onwbp.base.text.UserMessage label,
                           com.onwbp.base.text.UserMessage description,
                           String defaultValue)

ParameterDefinition

public ParameterDefinition(String name,
                           com.orchestranetworks.schema.SchemaTypeName type,
                           com.onwbp.base.text.UserMessage label,
                           com.onwbp.base.text.UserMessage description,
                           ListConstraint listConstraint)

ParameterDefinition

public ParameterDefinition(String name,
                           com.onwbp.base.text.UserMessage label,
                           com.onwbp.base.text.UserMessage description,
                           String htmlComponent,
                           ListConstraint listConstraint,
                           String defaultValue)

Method Detail

getName

public String getName()

Returns name of parameter.

Since:

1.5.0

getType

public com.orchestranetworks.schema.SchemaTypeName getType()

Returns a parameter's SchemaTypeName.

Since:

1.5.0

getHTMLComponent

public String getHTMLComponent()

Returns HTMLComponent type of this parameter definition.

Since:

1.6.0

getLabel

public com.onwbp.base.text.UserMessage getLabel()

Returns a parameter's label.

Since:

1.5.0

getDescription

public com.onwbp.base.text.UserMessage getDescription()

Returns parameter's description.

Since:

1.5.0

getDefaultValue

public String getDefaultValue()

Returns the predefined value of a parameter if isList() is false.

Since:

1.5.0

getDefaultValues

public List<String> getDefaultValues()

Returns an empty list if isList() is false.

Since:

1.5.0

See Also:

ListConstraint.getDefaultValues()

isList

public boolean isList()

Returns true if its definition is a multiple occurrence.

Since:

1.5.0

hasHTMLComponent

public boolean hasHTMLComponent()

Returns true if current parameter definition has an HTML component.

Since:

1.6.0

getMinOccurs

public int getMinOccurs()

Returns 1 if isList() is false.

Since:

1.5.0

See Also:

ListConstraint.getMinOccurs()

getMaxOccurs

public int getMaxOccurs()

Returns 1 if isList() is false.

Since:

1.5.0

See Also:

ListConstraint.getMaxOccurs()

getCustomSelection

public String getCustomSelection()

Returns the custom selection type of this parameter definition.

Since:

1.6.0

isCustomSelection

public boolean isCustomSelection()

Returns true if current parameter definition is a custom selection.

Since:

1.6.0