commonj.connector.tool
Interface ToolContext.ProgressMonitor

Enclosing interface:
ToolContext

public static interface ToolContext.ProgressMonitor

If the discovery service can take more than 1 to 2 seconds to complete an operation, it should call methods on this interface to indicate how much work needs to be done, and the current progress in completing the work. Tool environments will provide the implementation of this interface. Typically the implementation will map to the UI progress monitors that the tool environment displays to users.

See Also:
ProgressMonitor

Method Summary
 void close()
          This method is identical to ProgressMonitor
 int getMaximum()
          This method is identical to ProgressMonitor
 int getMinimum()
          This method is identical to ProgressMonitor
 String getNote()
          This method is identical to ProgressMonitor
 boolean isCanceled()
          This method is identical to ProgressMonitor
 void setMaximum(int m)
          This method is identical to ProgressMonitor
 void setMinimum(int m)
          This method is identical to ProgressMonitor
 void setNote(String note)
          This method is identical to ProgressMonitor
 void setProgress(int nv)
          This method is identical to ProgressMonitor
 

Method Detail

close

void close()
This method is identical to ProgressMonitor


getMaximum

int getMaximum()
This method is identical to ProgressMonitor

Returns:
ProgressMonitor

getMinimum

int getMinimum()
This method is identical to ProgressMonitor

Returns:
ProgressMonitor

getNote

String getNote()
This method is identical to ProgressMonitor

Returns:
ProgressMonitor

This is a locale specific object that must be separated to a ResourceBundle, translated, and retrieved using the locale of the tool environment.

See Also:
ResourceBundle, MessageFormat

isCanceled

boolean isCanceled()
This method is identical to ProgressMonitor

Returns:
ProgressMonitor

setMaximum

void setMaximum(int m)
This method is identical to ProgressMonitor

Parameters:
m - ProgressMonitor

setMinimum

void setMinimum(int m)
This method is identical to ProgressMonitor

Parameters:
m - ProgressMonitor

setNote

void setNote(String note)
This method is identical to ProgressMonitor

Parameters:
note - ProgressMonitor

This is a locale specific object that must be separated to a ResourceBundle, translated, and retrieved using the locale of the tool environment.

See Also:
ResourceBundle, MessageFormat

setProgress

void setProgress(int nv)
This method is identical to ProgressMonitor

Parameters:
nv - ProgressMonitor