HDIV API 2.0.4

org.hdiv.state
Class Parameter

java.lang.Object
  extended by org.hdiv.state.Parameter
All Implemented Interfaces:
java.io.Serializable, IParameter

public class Parameter
extends java.lang.Object
implements IParameter, java.io.Serializable

Data struture to store all the values of a parameter

Author:
Roberto Velasco
See Also:
Serialized Form

Constructor Summary
Parameter()
          Creates a new Parameter object.
 
Method Summary
 void addValue(java.lang.String value)
          Adds the value value to the parameter this.
 boolean existPosition(int position)
          Checks if the position position exists in the array of values values.
 boolean existValue(java.lang.String value)
          Checks if parameter has value.
 int getCount()
           
 java.lang.String getEditableDataType()
           
 java.lang.String getName()
           
 java.lang.String getValuePosition(int position)
           
 java.util.List getValues()
           
 void init()
          Initialization of the parameter this value array
 boolean isActionParam()
          Indicates if the parameter has been added to the action attribute of a link or form.
 boolean isEditable()
           
 void setActionParam(boolean actionParam)
           
 void setCount(int count)
           
 void setEditable(boolean editable)
           
 void setEditableDataType(java.lang.String editableDataType)
           
 void setName(java.lang.String name)
           
 void setValues(java.util.List values)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Parameter

public Parameter()
Creates a new Parameter object.

Method Detail

init

public void init()
Initialization of the parameter this value array


addValue

public void addValue(java.lang.String value)
Adds the value value to the parameter this.

Specified by:
addValue in interface IParameter

existValue

public boolean existValue(java.lang.String value)
Checks if parameter has value.

Specified by:
existValue in interface IParameter
Returns:
True if value exists in the array of values values. False otherwise.

existPosition

public boolean existPosition(int position)
Checks if the position position exists in the array of values values.

Specified by:
existPosition in interface IParameter
Returns:
True if position is valid position in the array of values values. False otherwise.

getValuePosition

public java.lang.String getValuePosition(int position)
Specified by:
getValuePosition in interface IParameter
Returns:
Obtains the value of the position position in the list of values of the parameter.

getName

public java.lang.String getName()
Specified by:
getName in interface IParameter
Returns:
Returns the parameter name.

setName

public void setName(java.lang.String name)
Specified by:
setName in interface IParameter
Parameters:
name - The parameter name to set.

getValues

public java.util.List getValues()
Specified by:
getValues in interface IParameter
Returns:
Returns the values of parameter this.

setValues

public void setValues(java.util.List values)
Parameters:
values - The values to set.

isEditable

public boolean isEditable()
Specified by:
isEditable in interface IParameter
Returns:
Returns if parameter this is editbale or not.

setEditable

public void setEditable(boolean editable)
Specified by:
setEditable in interface IParameter
Parameters:
editable - The editable to set.

getCount

public int getCount()
Specified by:
getCount in interface IParameter
Returns:
Returns the count.

setCount

public void setCount(int count)
Parameters:
count - The count to set.

isActionParam

public boolean isActionParam()
Indicates if the parameter has been added to the action attribute of a link or form.

Specified by:
isActionParam in interface IParameter
Returns:
True if the parameter has been added to the action attribute of a link or form. False in otherwise.

setActionParam

public void setActionParam(boolean actionParam)
Specified by:
setActionParam in interface IParameter
Parameters:
actionParam - The actionParam to set.

getEditableDataType

public java.lang.String getEditableDataType()
Specified by:
getEditableDataType in interface IParameter
Returns:
Returns the editable data type.

setEditableDataType

public void setEditableDataType(java.lang.String editableDataType)
Specified by:
setEditableDataType in interface IParameter
Parameters:
editableDataType - The editable data type to set.

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

HDIV 2.0.4

Copyright © 2008 hdiv.org. All Rights Reserved.