IBM Rational Software Modeler
Release 6.0

com.ibm.xtools.ras.export.engine.tasks
Class AbstractExportEngineTaskImpl

java.lang.Object
  extended bycom.ibm.xtools.ras.export.engine.tasks.AbstractExportEngineTaskImpl
All Implemented Interfaces:
IExportEngineTask

public abstract class AbstractExportEngineTaskImpl
extends Object
implements IExportEngineTask

Abstract base class that implements all the get and set methods required by the IExportEngineTask interface alleviating any child export tasks from being forced to duplicate this functionality. This leaves only the main execute method to be implemented by any sub classes.


Field Summary
 
Fields inherited from interface com.ibm.xtools.ras.export.engine.tasks.IExportEngineTask
FINALIZE, INITIALIZE, UPDATE, VALIDATE
 
Constructor Summary
AbstractExportEngineTaskImpl()
           
 
Method Summary
 String getID()
          Retrieves the ID of the task.
 String getName()
          Retrieves the name of the task.
 int getPriority()
          Retrieves the execution priority for the task.
 String getProgressDescription()
          Retrieves the progress description of the task.
 String getType()
          Retrieves the type of the task.
 void setID(String theID)
          Sets the ID of the task.
 void setName(String theName)
          Sets the name of the task.
 void setPriority(int thePriority)
          Sets the execution priority for the task.
 void setProgressDescription(String theProgressDescription)
          Sets the progress description of the task.
 void setType(String theType)
          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.export.engine.tasks.IExportEngineTask
execute
 

Constructor Detail

AbstractExportEngineTaskImpl

public AbstractExportEngineTaskImpl()
Method Detail

getID

public String getID()
Description copied from interface: IExportEngineTask
Retrieves the ID of the task. It will correspond to the value defined in the plugin.xml for the 'id' attribute of the 'task' element for the 'exportEngineTask' extension point.

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

setID

public void setID(String theID)
Description copied from interface: IExportEngineTask
Sets the ID of the task. It should correspond to the value defined in the plugin.xml for the 'id' attribute of the 'task' element for the 'exportEngineTask' extension point.

Specified by:
setID in interface IExportEngineTask
Parameters:
theID - of the task

getName

public String getName()
Description copied from interface: IExportEngineTask
Retrieves the name of the task. It will correspond to the value defined in the plugin.xml for the 'name' attribute of the 'task' element for the 'exportEngineTask' extension point.

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

setName

public void setName(String theName)
Description copied from interface: IExportEngineTask
Sets the name of the task. It should correspond to the value defined in the plugin.xml for the 'name' attribute of the 'task' element for the 'exportEngineTask' extension point.

Specified by:
setName in interface IExportEngineTask
Parameters:
theName - of the task.

getPriority

public int getPriority()
Description copied from interface: IExportEngineTask
Retrieves the execution priority for the task. It will correspond to the value defined in the plugin.xml for the 'priority' attribute of the 'task' element for the 'exportEngineTask' extension point.

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

setPriority

public void setPriority(int thePriority)
Description copied from interface: IExportEngineTask
Sets the execution priority for the task. It should correspond to the value defined in the plugin.xml for the 'priority' attribute of the 'task' element for the 'exportEngineTask' extension point.

Specified by:
setPriority in interface IExportEngineTask
Parameters:
thePriority - of the task.

getProgressDescription

public String getProgressDescription()
Description copied from interface: IExportEngineTask
Retrieves the progress description of the task. It will correspond to the value defined in the plugin.xml for the 'progress_description' attribute of the 'task' element for the 'exportEngineTask' extension point.

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

setProgressDescription

public void setProgressDescription(String theProgressDescription)
Description copied from interface: IExportEngineTask
Sets the progress description of the task. It should correspond to the value defined in the plugin.xml for the 'progress_description' attribute of the 'task' element for the 'exportEngineTask' extension point.

Specified by:
setProgressDescription in interface IExportEngineTask
Parameters:
theProgressDescription - of the task.

getType

public String getType()
Description copied from interface: IExportEngineTask
Retrieves the type of the task. It will correspond to the value defined in the plugin.xml for the 'type' attribute of the 'task' element for the 'exportEngineTask' extension point.

Specified by:
getType in interface IExportEngineTask
Returns:
the type of the task. The value will be one of the following

setType

public void setType(String theType)
Description copied from interface: IExportEngineTask
Sets the type of the task. It should correspond to the value defined in the plugin.xml for the 'type' attribute of the 'task' element for the 'exportEngineTask' extension point.

Specified by:
setType in interface IExportEngineTask
Parameters:
theType - of the task. The value should be one of the following

IBM Rational Software Modeler
Release 6.0


Guidelines for using Eclipse APIs.

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