com.jbbres.lib.actions.elements
Interface Element

All Known Subinterfaces:

Action, Variable

All Known Implementing Classes:

AbstractAction, AbstractElement, AbstractVariable, RuntimeVariable, SimpleAction, SimpleElement, SimpleVariable, StorageVariable, VariableAction

public interface Element

An interface that specifies all methods essential to an Action(s) 's element (an action or a variable). An implementation of Element has 4 major methods:

• getService() - 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.
• getParameters() and setParameters(Parameters) - respectively stores and loads the state of the element.
• getDescription() - a method that returns a dictionary derived from the element description, usually the information specified in the element information property list.

This interface is not meant to be instaciated directly. Action and Variable are to be instanciated instead.

For more information on how to create your own elements, consult the Action(s) Developer Guide or visit http://app.jbbres.com/actions/developers/.

Since:

1.0.0

Version:

1.0.0

Author:

Jean-Baptiste Bres

Method Summary

ElementDescription<?>	getDescription() Returns the description of the element.
Parameters	getParameters() Returns the state of the element.
ElementService	getService() Returns the service associated to the element.
void	setParameters(Parameters parameters) Sets the current state of the element.

Method Detail

getService

ElementService getService()

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.

Returns:

the service associated to the element.

See Also:

ElementService

getDescription

ElementDescription<?> getDescription()

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.

Returns:

the description of the element.

See Also:

ElementDescription

getParameters

Parameters getParameters()

Returns the state of the element.

Returns:

the current state of the element.

See Also:

setParameters(Parameters), Parameters

setParameters

void setParameters(Parameters parameters)
                   throws InvalidParametersException

Sets the current state of the 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:

getParameters(), Parameters