IBM Branch Transformation Toolkit Javadoc

com.ibm.dse.desktop
Interface TaskLauncher

All Known Implementing Classes:
Bookmark, LeafTreeNode, MenuItem, TaskLauncherButton

public interface TaskLauncher

The TaskLauncher interface must be implemented for any element that is able to launch tasks.


Method Summary
 java.lang.String getApplication()
          Gets the ID of the application related to the task described by the TaskLauncher.
 java.lang.String getCode()
          Gets the code of the task described by the TaskLauncher.
 java.lang.String getErrorMessageOnInstantiateOperation()
          Gets the error message of the task described by the TaskLauncher.
 java.lang.Boolean getExecuteOperation()
          Gets the executeOperation flag of the TaskLauncher.
 int getHeightNavigationArea()
          Returns the value of the height property.
 java.lang.String getLaunchable()
          Returns the name of the process/operation/application launched from the TaskLauncher.
 java.lang.String getLongDescription()
          Gets the long description of the task described by the TaskLauncher.
 java.lang.String getOperation()
          Gets the ID of the operation related to the task described by the TaskLauncher.
 java.lang.String getOperationPanel()
          Gets the name of the operation panel related to the task described by the TaskLauncher.
 java.lang.String getParameters()
          Gets the parameters of the task described by the TaskLauncher.
 java.lang.String getProcess()
          Gets the ID of the process related to the task described by the TaskLauncher.
 java.lang.String getShortDescription()
          Gets the short description of the task described by the TaskLauncher.
 java.lang.String getTaskName()
          Gets the name of the task described by the TaskLauncher.
 java.lang.String getTypeLaunchable()
          Gets the type of the task described by the TaskLauncher.
 int getWidthNavigationArea()
          Gets the width of the navigation area of the TaskLauncherButton.
 int getXNavigationArea()
          Gets the X position of the NavigationArea.
 int getYNavigationArea()
          Gets the Y position of the NavigationArea.
 

Method Detail

getApplication

public java.lang.String getApplication()
Gets the ID of the application related to the task described by the TaskLauncher.

Returns:
java.lang.String

getCode

public java.lang.String getCode()
Gets the code of the task described by the TaskLauncher.

Returns:
java.lang.String

getErrorMessageOnInstantiateOperation

public java.lang.String getErrorMessageOnInstantiateOperation()
Gets the error message of the task described by the TaskLauncher.

Returns:
java.lang.String

getExecuteOperation

public java.lang.Boolean getExecuteOperation()
Gets the executeOperation flag of the TaskLauncher.

Returns:
boolean

getHeightNavigationArea

public int getHeightNavigationArea()
Returns the value of the height property.

Returns:
int - the current value of height

getLaunchable

public java.lang.String getLaunchable()
Returns the name of the process/operation/application launched from the TaskLauncher.


getLongDescription

public java.lang.String getLongDescription()
Gets the long description of the task described by the TaskLauncher.

Returns:
java.lang.String

getOperation

public java.lang.String getOperation()
Gets the ID of the operation related to the task described by the TaskLauncher.

Returns:
java.lang.String

getOperationPanel

public java.lang.String getOperationPanel()
Gets the name of the operation panel related to the task described by the TaskLauncher.

Returns:
java.lang.String

getParameters

public java.lang.String getParameters()
Gets the parameters of the task described by the TaskLauncher.

Returns:
java.lang.String

getProcess

public java.lang.String getProcess()
Gets the ID of the process related to the task described by the TaskLauncher.

Returns:
java.lang.String

getShortDescription

public java.lang.String getShortDescription()
Gets the short description of the task described by the TaskLauncher.

Returns:
java.lang.String

getTaskName

public java.lang.String getTaskName()
Gets the name of the task described by the TaskLauncher.

Returns:
java.lang.String

getTypeLaunchable

public java.lang.String getTypeLaunchable()
Gets the type of the task described by the TaskLauncher.

Returns:
int

getWidthNavigationArea

public int getWidthNavigationArea()
Gets the width of the navigation area of the TaskLauncherButton.

Returns:
int

getXNavigationArea

public int getXNavigationArea()
Gets the X position of the NavigationArea.

Returns:
int

getYNavigationArea

public int getYNavigationArea()
Gets the Y position of the NavigationArea.

Returns:
int

IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005