|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The IOpenTool interface must be implemented by an Open Tool class for use in Data Integrator packages. It provides methods to get the description, icon, provider, syntax and version of the Open Tool, as well as the list of parameters it takes. It must also provide the execute() method, which is called to carry out the main functionality of the Open Tool. The name of the Open Tool is the first word of the Syntax.
Field Summary | |
static int |
BIG_ICON
A constant used to refer to the large icon type, as passed to the function getIcon(). |
static int |
SMALL_ICON
A constant used to refer to the small icon type, as passed to the function getIcon(). |
Method Summary | |
void |
execute()
Called to carry out the main functionality of the Open Tool. |
java.lang.String |
getDescription()
Returns a description of this Open Tool. |
java.lang.String |
getIcon(int pIconType)
Returns a path to the .gif file within the Open Tool's .jar package for the icon of a certain type. |
IOpenToolParameter[] |
getParameters()
Returns an array of IOpenToolParameter objects that can be used to configure the behavior of this Open Tool when it is executed. |
java.lang.String |
getProvider()
Returns the name of the provider of this Open Tool. |
java.lang.String |
getSyntax()
Returns the syntax of the Open Tool which is used to initialize the Command and General tabs of the tool in the package window. |
java.lang.String |
getVersion()
Returns the version number of this Open Tool. |
Field Detail |
public static final int SMALL_ICON
public static final int BIG_ICON
Method Detail |
public void execute() throws OpenToolExecutionException
OpenToolExecutionException
public java.lang.String getSyntax()
public java.lang.String getDescription()
public java.lang.String getVersion()
public java.lang.String getProvider()
public java.lang.String getIcon(int pIconType)
public IOpenToolParameter[] getParameters()
IOpenToolParameter
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |