IBM Rational Software Modeler
Release 6.0

com.ibm.xtools.ras.impord.engine.tasks
Class AbstractImportEngineTask

java.lang.Object
  extended bycom.ibm.xtools.ras.impord.engine.tasks.AbstractImportEngineTask
All Implemented Interfaces:
IImportEngineTask

public abstract class AbstractImportEngineTask
extends Object
implements IImportEngineTask

Retrieves or sets the attributes for the task.

The attributes correspond to the task attributes defined in the importEngineTask extensionPoint.

Note: This class/interface is part of an interim API that is still under development and expected to change significantly before reaching stability.


Field Summary
 
Fields inherited from interface com.ibm.xtools.ras.impord.engine.tasks.IImportEngineTask
PRIORITY_MAX, PRIORITY_MIN, TYPE_EXTRACT, TYPE_FINALIZE, TYPE_INITIALIZE, TYPE_UPDATE
 
Constructor Summary
AbstractImportEngineTask()
           
 
Method Summary
 String getID()
           Retrieves the unique identifier (ID) of the task.
 String getName()
           Retrieves the name of the task.
 int getPriority()
           Retrieves the priority of the task.
 String getProgressDescription()
           Retrieves the progress description of the task.
 String getType()
           Retrieves the type of the task.
 void setID(String taskID)
          Sets the unique identifier (ID) of the task.
 void setName(String taskName)
          Sets the name of the task.
 void setPriority(int taskPriority)
          Sets the priority of the task.
 void setProgressDescription(String taskProgressDescription)
          Sets the progress description of the task.
 void setType(String taskType)
          Sets the type of the task.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.xtools.ras.impord.engine.tasks.IImportEngineTask
execute
 

Constructor Detail

AbstractImportEngineTask

public AbstractImportEngineTask()
Method Detail

getName

public String getName()
Description copied from interface: IImportEngineTask

Retrieves the name of the task.

The name of the task corresponds to the name attribute defined in the importEngineTask extension point. To set the name of the task, use the setNamemethod.

Specified by:
getName in interface IImportEngineTask
Returns:
Returns the name of the task.

setName

public void setName(String taskName)
Description copied from interface: IImportEngineTask
Sets the name of the task.

The name is called by the import framework automatically.

Specified by:
setName in interface IImportEngineTask
Parameters:
taskName - The name that corresponds to the name attribute in the importEngineTask extension.

getID

public String getID()
Description copied from interface: IImportEngineTask

Retrieves the unique identifier (ID) of the task.

The ID is unique, machine-generated and corresponds to the ID attribute defined in the importEngineTask extension point. Use the setIDmethod to set the task ID.

Specified by:
getID in interface IImportEngineTask
Returns:
Returns the ID of the task.

setID

public void setID(String taskID)
Description copied from interface: IImportEngineTask
Sets the unique identifier (ID) of the task.

The ID is called by the import framework automatically.

Specified by:
setID in interface IImportEngineTask
Parameters:
taskID - The task ID that corresponds to the ID attribute in the importEngineTask extension.

getType

public String getType()
Description copied from interface: IImportEngineTask

Retrieves the type of the task.

The type of task corresponds to the type attribute defined in the importEngineTask extension point. To set the type of the task, use the setTypemethod.

Specified by:
getType in interface IImportEngineTask
Returns:
Returns the type of the task.

The return values are:


setType

public void setType(String taskType)
Description copied from interface: IImportEngineTask
Sets the type of the task.

The task type is called by the import framework automatically. The type of the task can have the following values:

Specified by:
setType in interface IImportEngineTask
Parameters:
taskType - The type of the task that corresponds to the type attribute in the importEngineTask extension.

getPriority

public int getPriority()
Description copied from interface: IImportEngineTask

Retrieves the priority of the task.

The priority type of the task corresponds to the priority attribute defined in the importEngineTask extension point. Use the setPrioritymethod to set the priority of the task.

Specified by:
getPriority in interface IImportEngineTask
Returns:
Returns the priority of the task.

The return value has a range of 0..100.


setPriority

public void setPriority(int taskPriority)
Description copied from interface: IImportEngineTask
Sets the priority of the task.

The priority values can have a range of 0..100. It is called by the import framework automatically.

Specified by:
setPriority in interface IImportEngineTask
Parameters:
taskPriority - The task priority that corresponds to the priority attribute in the importEngineTask extension.

getProgressDescription

public String getProgressDescription()
Description copied from interface: IImportEngineTask

Retrieves the progress description of the task.

The progress description of the task corresponds to the progress description attribute defined in the importEngineTask extension point. It is called by the import framework automatically.

Specified by:
getProgressDescription in interface IImportEngineTask
Returns:
Returns the progress description of the task.

setProgressDescription

public void setProgressDescription(String taskProgressDescription)
Description copied from interface: IImportEngineTask
Sets the progress description of the task.

It is called by the import framework automatically.

Specified by:
setProgressDescription in interface IImportEngineTask
Parameters:
taskProgressDescription - The task progress description that corresponds to the progress description attribute in the importEngineTask extension.

IBM Rational Software Modeler
Release 6.0


Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2004. All rights reserved.