com.jbbres.lib.actions.tools.elements.variables
Class VariableAction

java.lang.Object
  extended by com.jbbres.lib.actions.tools.elements.variables.VariableAction
All Implemented Interfaces:
Action, Element

public class VariableAction
extends java.lang.Object
implements Action

A concrete implementation of Action that returns the value of a Variable selected via its UI. When applicable, the user can also choose to change the value of the variable by affecting it the result of the previous action in the workflow.

Since:
1.0.0
Version:
1.0.0
Author:
Jean-Baptiste Bres

Constructor Summary
VariableAction(Workflow workflow)
          Instantiates a new variable action.
VariableAction(Workflow workflow, Variable variable)
          Instantiates a new variable action.
 
Method Summary
 ActionDescription getDescription()
          Returns the description of the element.
 Parameters getParameters()
          Returns the state of the element.
 VariableActionService getService()
          Returns the service associated to the element.
 VariableActionUI getUI()
          returns the User Interface displayed in the workflow definition panel in Action(s), and that user can use to define the settings of the action.
 Workflow getWorkflow()
          Returns the workflow.
 void setParameters(Parameters parameters)
          Sets the current state of the element.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

VariableAction

public VariableAction(Workflow workflow)
               throws java.io.IOException
Instantiates a new variable action.

Parameters:
workflow - - the workflow
Throws:
java.io.IOException - Signals that an I/O exception has occurred.

VariableAction

public VariableAction(Workflow workflow,
                      Variable variable)
               throws java.io.IOException
Instantiates a new variable action.

Parameters:
workflow - - the workflow
variable - - the variable
Throws:
java.io.IOException - Signals that an I/O exception has occurred.
Method Detail

getWorkflow

public Workflow getWorkflow()
Returns the workflow.

Returns:
the workflow

getService

public VariableActionService getService()
Description copied from interface: Element
Returns the service associated to the element. The service describes how the element performs within the workflow. For example, if the element is an action, the service will contain the executable methods that the action is designed to perform. If the element is a variable, the service will contain methods related to data access.

Specified by:
getService in interface Action
Specified by:
getService in interface Element
Returns:
the service associated to the element.
See Also:
ElementService

getUI

public VariableActionUI getUI()
Description copied from interface: Action
returns the User Interface displayed in the workflow definition panel in Action(s), and that user can use to define the settings of the action.

Specified by:
getUI in interface Action
Returns:
the User Interface displayed in the workflow definition panel

getDescription

public ActionDescription getDescription()
Description copied from interface: Element
Returns the description of the element. The description is a dictionary derived from the element description, usually the information specified in the element information property list.

Specified by:
getDescription in interface Action
Specified by:
getDescription in interface Element
Returns:
the description of the element.
See Also:
ElementDescription

getParameters

public Parameters getParameters()
Description copied from interface: Element
Returns the state of the element.

Specified by:
getParameters in interface Element
Returns:
the current state of the element.
See Also:
Element.setParameters(Parameters), Parameters

setParameters

public void setParameters(Parameters parameters)
                   throws InvalidParametersException
Description copied from interface: Element
Sets the current state of the element.

Specified by:
setParameters in interface Element
Parameters:
parameters - - the parameters. Can be null
Throws:
InvalidParametersException - Occurs when the parameters received are incorrect and cannot be mapped in the element.
See Also:
Element.getParameters(), Parameters


To file bugs or suggest feature enhancements, visit the app.jbbres.com Bug Reporter website.

Additional documentation available online at http://app.jbbres.com/actions/developers.

Copyright � 2009-2011 app.jbbres.com. All Rights Reserved.