org.ow2.clif.scenario.isac.egui.plugins
Class ControlDescription

java.lang.Object
  extended by org.ow2.clif.scenario.isac.egui.plugins.ControlDescription
All Implemented Interfaces:
ActionDescription

public class ControlDescription
extends java.lang.Object
implements ActionDescription

This class store a control description

Author:
Joan Chaumont

Constructor Summary
ControlDescription(java.lang.String name, java.lang.String number, java.util.Vector<ParameterDescription> params, java.util.Vector<java.lang.String> help)
          Build a new timer description object, used to store information about a timer action
 
Method Summary
 void createNodeDescription(NodeDescription desc)
          Method which update the node description for this action The node have been initialised with the rigth type, we initialise the other fields
 java.lang.String getGUIKey()
          GUIKey getter
 java.util.Vector<java.lang.String> getHelp()
          Help getter
 java.lang.String getName()
          Name getter
 java.lang.String getNumber()
          Attribute number getter
 java.util.Vector<ParameterDescription> getParams()
          Attribute params getter
 void setGUIKey(java.lang.String guiKey)
          The GUIKey Setter, this key is the reference in the table which store the parameters definitions interfaces
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ControlDescription

public ControlDescription(java.lang.String name,
                          java.lang.String number,
                          java.util.Vector<ParameterDescription> params,
                          java.util.Vector<java.lang.String> help)
Build a new timer description object, used to store information about a timer action

Parameters:
name - The name of the action
number - The number of the timer in the object timer table
params - The parameters definitions
help - The help for this action
Method Detail

createNodeDescription

public void createNodeDescription(NodeDescription desc)
Description copied from interface: ActionDescription
Method which update the node description for this action The node have been initialised with the rigth type, we initialise the other fields

Specified by:
createNodeDescription in interface ActionDescription
Parameters:
desc - The node description

getHelp

public java.util.Vector<java.lang.String> getHelp()
Description copied from interface: ActionDescription
Help getter

Specified by:
getHelp in interface ActionDescription
Returns:
The help

getGUIKey

public java.lang.String getGUIKey()
Description copied from interface: ActionDescription
GUIKey getter

Specified by:
getGUIKey in interface ActionDescription
Returns:
The key

setGUIKey

public void setGUIKey(java.lang.String guiKey)
Description copied from interface: ActionDescription
The GUIKey Setter, this key is the reference in the table which store the parameters definitions interfaces

Specified by:
setGUIKey in interface ActionDescription
Parameters:
guiKey - The key

getName

public java.lang.String getName()
Description copied from interface: ActionDescription
Name getter

Specified by:
getName in interface ActionDescription
Returns:
The name

getNumber

public java.lang.String getNumber()
Attribute number getter

Returns:
The number of the control, in the object controls table

getParams

public java.util.Vector<ParameterDescription> getParams()
Attribute params getter

Specified by:
getParams in interface ActionDescription
Returns:
The parameters descriptions