com.silverpeas.admin.components
Class Parameter

java.lang.Object
  com.silverpeas.admin.components.Parameter

All Implemented Interfaces:

Cloneable

public class Parameter
extends Object
implements Cloneable

Java class for ParameterType complex type.

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

 <complexType name="ParameterType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="name" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="label" type="{http://silverpeas.org/xml/ns/component}multilang"/>
         <element name="order" type="{http://www.w3.org/2001/XMLSchema}int"/>
         <element name="mandatory" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="value" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="options" maxOccurs="unbounded" minOccurs="0">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <sequence>
                   <element name="option" type="{http://silverpeas.org/xml/ns/component}ParameterOptionType" maxOccurs="unbounded" minOccurs="0"/>
                 </sequence>
               </restriction>
             </complexContent>
           </complexType>
         </element>
         <element name="type">
           <simpleType>
             <restriction base="{http://www.w3.org/2001/XMLSchema}string">
               <enumeration value="checkbox"/>
               <enumeration value="select"/>
               <enumeration value="xmltemplates"/>
               <enumeration value="text"/>
               <enumeration value="radio"/>
             </restriction>
           </simpleType>
         </element>
         <element name="size" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="updatable">
           <simpleType>
             <restriction base="{http://www.w3.org/2001/XMLSchema}string">
               <enumeration value="always"/>
               <enumeration value="creation"/>
               <enumeration value="never"/>
             </restriction>
           </simpleType>
         </element>
         <element name="help" type="{http://silverpeas.org/xml/ns/component}multilang"/>
         <element name="personalSpaceValue" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

protected HashMap<String,String>	help
protected HashMap<String,String>	label
protected boolean	mandatory
protected String	name
protected List<Option>	options
protected int	order
protected String	personalSpaceValue
protected Integer	size
protected String	type
protected String	updatable
protected String	value
protected HashMap<String,String>	warning

Constructor Summary

Parameter()

Method Summary

Parameter	clone()
HashMap<String,String>	getHelp() Gets the value of the help property.
String	getHelp(String lang)
HashMap<String,String>	getLabel() Gets the value of the label property.
String	getLabel(String lang)
String	getName() Gets the value of the name property.
List<Option>	getOptions() Gets the value of the options property.
int	getOrder() Gets the value of the order property.
String	getPersonalSpaceValue() Gets the value of the personalSpaceValue property.
Integer	getSize() Gets the value of the size property.
String	getType() Gets the value of the type property.
String	getUpdatable() Gets the value of the updatable property.
String	getValue() Gets the value of the value property.
HashMap<String,String>	getWarning() Gets the value of the warning property.
String	getWarning(String lang)
boolean	isAlwaysUpdatable()
boolean	isCheckbox()
boolean	isHidden()
boolean	isMandatory() Gets the value of the mandatory property.
boolean	isNeverUpdatable()
boolean	isRadio()
boolean	isSelect()
boolean	isText()
boolean	isUpdatableOnCreationOnly()
boolean	isVisible()
boolean	isXmlTemplate()
void	setHelp(HashMap<String,String> value) Sets the value of the help property.
void	setLabel(HashMap<String,String> value) Sets the value of the label property.
void	setMandatory(boolean value) Sets the value of the mandatory property.
void	setName(String value) Sets the value of the name property.
void	setOptions(List<Option> options)
void	setOrder(int value) Sets the value of the order property.
void	setPersonalSpaceValue(String value) Sets the value of the personalSpaceValue property.
void	setSize(Integer value) Sets the value of the size property.
void	setType(String value) Sets the value of the type property.
void	setUpdatable(String value) Sets the value of the updatable property.
void	setValue(String value) Sets the value of the value property.
void	setWarning(HashMap<String,String> value) Sets the value of the warning property.

Methods inherited from class java.lang.Object

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

Field Detail

name

protected String name

label

protected HashMap<String,String> label

order

protected int order

mandatory

protected boolean mandatory

value

protected String value

options

protected List<Option> options

type

protected String type

size

protected Integer size

updatable

protected String updatable

help

protected HashMap<String,String> help

warning

protected HashMap<String,String> warning

personalSpaceValue

protected String personalSpaceValue

Constructor Detail

Parameter

public Parameter()

Method Detail

getName

public String getName()

Gets the value of the name property.

Returns:

possible object is String

setName

public void setName(String value)

Sets the value of the name property.

Parameters:

value - allowed object is String

getLabel

public HashMap<String,String> getLabel()

Gets the value of the label property.

Returns:

possible object is Multilang

getLabel

public String getLabel(String lang)

setLabel

public void setLabel(HashMap<String,String> value)

Sets the value of the label property.

Parameters:

value - allowed object is Multilang

getOrder

public int getOrder()

Gets the value of the order property.

setOrder

public void setOrder(int value)

Sets the value of the order property.

isMandatory

public boolean isMandatory()

Gets the value of the mandatory property.

setMandatory

public void setMandatory(boolean value)

Sets the value of the mandatory property.

getValue

public String getValue()

Gets the value of the value property.

Returns:

possible object is String

setValue

public void setValue(String value)

Sets the value of the value property.

Parameters:

value - allowed object is String

getOptions

public List<Option> getOptions()

Gets the value of the options 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 options property.

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

 getOptions().add(newItem);
 

Objects of the following type(s) are allowed in the list Parameter.Options

setOptions

public void setOptions(List<Option> options)

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

getSize

public Integer getSize()

Gets the value of the size property.

Returns:

possible object is Integer

setSize

public void setSize(Integer value)

Sets the value of the size property.

Parameters:

value - allowed object is Integer

getUpdatable

public String getUpdatable()

Gets the value of the updatable property.

Returns:

possible object is String

setUpdatable

public void setUpdatable(String value)

Sets the value of the updatable property.

Parameters:

value - allowed object is String

getHelp

public String getHelp(String lang)

getHelp

public HashMap<String,String> getHelp()

Gets the value of the help property.

Returns:

possible object is Multilang

setHelp

public void setHelp(HashMap<String,String> value)

Sets the value of the help property.

Parameters:

value - allowed object is Multilang

getWarning

public HashMap<String,String> getWarning()

Gets the value of the warning property.

Returns:

possible object is Multilang

getWarning

public String getWarning(String lang)

setWarning

public void setWarning(HashMap<String,String> value)

Sets the value of the warning property.

Parameters:

value - allowed object is Multilang

getPersonalSpaceValue

public String getPersonalSpaceValue()

Gets the value of the personalSpaceValue property.

Returns:

possible object is String

setPersonalSpaceValue

public void setPersonalSpaceValue(String value)

Sets the value of the personalSpaceValue property.

Parameters:

value - allowed object is String

isVisible

public boolean isVisible()

isHidden

public boolean isHidden()

isUpdatableOnCreationOnly

public boolean isUpdatableOnCreationOnly()

isAlwaysUpdatable

public boolean isAlwaysUpdatable()

isNeverUpdatable

public boolean isNeverUpdatable()

isText

public boolean isText()

isCheckbox

public boolean isCheckbox()

isRadio

public boolean isRadio()

isSelect

public boolean isSelect()

isXmlTemplate

public boolean isXmlTemplate()

clone

public Parameter clone()

Overrides:

clone in class Object