oracle.odi.sdk.opentools

Interface IOpenToolParameter

All Known Implementing Classes:

OpenToolParameter

public interface IOpenToolParameter

This interface must be implemented in order for an object to be used as a parameter to an IOpenTool. It specifies methods for setting and retrieving the name, code, current value and help text for a parameter, as well as whether it is mandatory or not.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCode() Returns the code (the actual word used on a command line) that represents the parameter.
java.lang.String	getHelp() Returns a string describing what the parameter does.
java.lang.String	getName() Returns the user-friendly name of the parameter.
java.lang.Object	getValue() Returns the value of this parameter previously set by setValue().
boolean	isMandatory() Returns a boolean that defines whether this parameter must be present for a command that calls the Open Tool to be valid.
void	setCode(java.lang.String pCode) Sets the parameter code.
void	setHelp(java.lang.String pHelp) Sets the help text which describes what the parameter does.
void	setMandatory(boolean pMandatory) Sets the flag that specifies whether this parameter is mandatory or not.
void	setName(java.lang.String pName) Sets the user-friendly name of the parameter.
void	setValue(java.lang.Object pValue) Sets the current value of this parameter.

Method Detail

getCode

java.lang.String getCode()

Returns the code (the actual word used on a command line) that represents the parameter. It must not contain any spaces, minus signs (-) or equals signs (=).

Returns:

The parameter code.

See Also:

setCode(String)

setCode

void setCode(java.lang.String pCode)

Sets the parameter code.

Parameters:

pCode - - The new code for this parameter.

See Also:

getCode()

getHelp

java.lang.String getHelp()

Returns a string describing what the parameter does. This text is displayed on the General tab of the properties pane for the Open Tool when used in a package.

Returns:

A string containing the help text.

See Also:

setHelp(String)

setHelp

void setHelp(java.lang.String pHelp)

Sets the help text which describes what the parameter does.

Parameters:

pHelp - - A string containing the new help text

See Also:

getHelp()

isMandatory

boolean isMandatory()

Returns a boolean that defines whether this parameter must be present for a command that calls the Open Tool to be valid.

Returns:

True if the parameter must be present; false if it is optional.

See Also:

setMandatory(boolean)

setMandatory

void setMandatory(boolean pMandatory)

Sets the flag that specifies whether this parameter is mandatory or not.

Parameters:

pMandatory - - The new value of the flag.

See Also:

isMandatory()

getName

java.lang.String getName()

Returns the user-friendly name of the parameter. This name, which may contain spaces and other characters, is displayed on the General tab of the properties pane of a package window.

Returns:

A string containing the user-friendly name.

See Also:

setName(String)

setName

void setName(java.lang.String pName)

Sets the user-friendly name of the parameter.

Parameters:

pName - - A string containing the new user-friendly name.

See Also:

getName()

getValue

java.lang.Object getValue()

Returns the value of this parameter previously set by setValue(). This can be any type of object.

Returns:

Any object representing the current value of the parameter.

See Also:

setValue(Object)

setValue

void setValue(java.lang.Object pValue)

Sets the current value of this parameter. This can be any type of object.

Parameters:

pValue - - The new current value of the parameter.

See Also:

getValue()