com.ibm.di.model.descriptor
Class ParameterDescriptor

java.lang.Object
  com.ibm.di.model.descriptor.ParameterDescriptor

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ModeParameterDescriptor

public class ParameterDescriptor
extends Object
implements Serializable

Java class for ParameterDescriptor complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="ParameterDescriptor">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="label" type="{http://www.ibm.com/xmlns/prod/tdi/71/core}Label" maxOccurs="unbounded"/>
         <element name="description" type="{http://www.ibm.com/xmlns/prod/tdi/71/core}Label" maxOccurs="unbounded"/>
         <element name="option" type="{http://www.ibm.com/xmlns/prod/tdi/71/core}Option" maxOccurs="unbounded" minOccurs="0"/>
         <element name="defaultValue" type="{http://www.w3.org/2001/XMLSchema}anySimpleType" minOccurs="0"/>
       </sequence>
       <attribute name="key" use="required" type="{http://www.w3.org/2001/XMLSchema}ID" />
       <attribute name="type" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="hidden" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="required" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="section" type="{http://www.w3.org/2001/XMLSchema}string" default="general" />
     </restriction>
   </complexContent>
 </complexType>
 

See Also:

Serialized Form

Field Summary

protected Object	defaultValue
protected List<Label>	description
protected Boolean	hidden
protected String	key
protected List<Label>	label
protected List<Option>	option
protected Boolean	required
protected String	section
protected String	type

Constructor Summary

ParameterDescriptor()

Method Summary

Object	getDefaultValue() Gets the value of the defaultValue property.
List<Label>	getDescriptions() Gets the value of the description property.
String	getKey() Gets the value of the key property.
List<Label>	getLabels() Gets the value of the label property.
List<Option>	getOptions() Gets the value of the option property.
String	getSection() Gets the value of the section property.
String	getType() Gets the value of the type property.
boolean	isHidden() Gets the value of the hidden property.
boolean	isRequired() Gets the value of the required property.
void	setDefaultValue(Object value) Sets the value of the defaultValue property.
void	setHidden(Boolean value) Sets the value of the hidden property.
void	setKey(String value) Sets the value of the key property.
void	setRequired(Boolean value) Sets the value of the required property.
void	setSection(String value) Sets the value of the section property.
void	setType(String value) Sets the value of the type property.

Methods inherited from class java.lang.Object

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

Field Detail

label

protected List<Label> label

description

protected List<Label> description

option

protected List<Option> option

defaultValue

protected Object defaultValue

key

protected String key

type

protected String type

hidden

protected Boolean hidden

required

protected Boolean required

section

protected String section

Constructor Detail

ParameterDescriptor

public ParameterDescriptor()

Method Detail

getLabels

public List<Label> getLabels()

Gets the value of the label property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the label property.

For example, to add a new item, do as follows:

 getLabel().add(newItem);
 

Objects of the following type(s) are allowed in the list Label

getDescriptions

public List<Label> getDescriptions()

Gets the value of the description property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the description property.

For example, to add a new item, do as follows:

 getDescription().add(newItem);
 

Objects of the following type(s) are allowed in the list Label

getOptions

public List<Option> getOptions()

Gets the value of the option property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the option property.

For example, to add a new item, do as follows:

 getOption().add(newItem);
 

Objects of the following type(s) are allowed in the list Option

getDefaultValue

public Object getDefaultValue()

Gets the value of the defaultValue property.

Returns:

possible object is Object

setDefaultValue

public void setDefaultValue(Object value)

Sets the value of the defaultValue property.

Parameters:

value - allowed object is Object

getKey

public String getKey()

Gets the value of the key property.

Returns:

possible object is String

setKey

public void setKey(String value)

Sets the value of the key property.

Parameters:

value - allowed object is String

getType

public String getType()

Gets the value of the type property.

Returns:

possible object is String

setType

public void setType(String value)

Sets the value of the type property.

Parameters:

value - allowed object is String

isHidden

public boolean isHidden()

Gets the value of the hidden property.

Returns:

possible object is Boolean

setHidden

public void setHidden(Boolean value)

Sets the value of the hidden property.

Parameters:

value - allowed object is Boolean

isRequired

public boolean isRequired()

Gets the value of the required property.

Returns:

possible object is Boolean

setRequired

public void setRequired(Boolean value)

Sets the value of the required property.

Parameters:

value - allowed object is Boolean

getSection

public String getSection()

Gets the value of the section property.

Returns:

possible object is String

setSection

public void setSection(String value)

Sets the value of the section property.

Parameters:

value - allowed object is String