org.jwarp.service.work
Interface IToolFactory

All Known Implementing Classes:

TESTWorkManager.TestToolFactory

public interface IToolFactory

Component interface for a tool. A Tool is a software piece that executes a function such as sending an email, showing a form or whatever. It is the execution part within the workflow compnent of JWeb.

Method Summary

java.lang.String	getDescription() Returns the description of this tool
java.lang.String	getName() Returns the tools default name (can be overridden ba xml configuration)
java.util.Iterator	getParameters() Returns the parameter description for this tool
ITool	makeTool(Parameter[] params) Run the tool using the concrete parameters passed.

Method Detail

makeTool

public ITool makeTool(Parameter[] params)
               throws java.lang.IllegalArgumentException

Run the tool using the concrete parameters passed.

Returns:

The tools result or null.

getParameters

public java.util.Iterator getParameters()

Returns the parameter description for this tool

Returns:

The tools parameters

getName

public java.lang.String getName()

Returns the tools default name (can be overridden ba xml configuration)

Returns:

The tools default name

getDescription

public java.lang.String getDescription()

Returns the description of this tool

Returns:

The tool descriptions.