IBM Rational Software Modeler
Release 6.0

com.ibm.xtools.ras.export.engine.tasks
Interface IExportEngineTask

All Known Implementing Classes:
AbstractExportEngineTaskImpl

public interface IExportEngineTask

A unit of work executed during the export operation by the RAS export service. The work will be executed in 1 of 4 distinct phases. This interface is intended to be implemented by clients.

See Also:
"The reference documentation for the 'exportEngineTask' extension point", AbstractExportEngineTaskImpl

Field Summary
static String FINALIZE
          Indicates the task should execute in the 'Finalize' phase of the export operation.
static String INITIALIZE
          Indicates that task should execute in the 'Initialize' phase of the export operation.
static String UPDATE
          Indicates the task should execute in the 'Update' phase of the export operation.
static String VALIDATE
          Indicates the task should execute in the 'Validate'phase of the export operation.
 
Method Summary
 org.eclipse.core.runtime.IStatus execute(IDefaultExportDataModel theExportDataModel, org.eclipse.core.runtime.IProgressMonitor theProgressMonitor)
          Executes the task.
 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.
 

Field Detail

INITIALIZE

public static final String INITIALIZE
Indicates that task should execute in the 'Initialize' phase of the export operation. During this phase any initialization work can be completed before the manifest has been updated.

See Also:
Constant Field Values

UPDATE

public static final String UPDATE
Indicates the task should execute in the 'Update' phase of the export operation. During this phase the manifest is updated.

See Also:
Constant Field Values

VALIDATE

public static final String VALIDATE
Indicates the task should execute in the 'Validate'phase of the export operation. During this phase the manifest is analyzed for completeness.

See Also:
Constant Field Values

FINALIZE

public static final String FINALIZE
Indicates the task should execute in the 'Finalize' phase of the export operation. During this phase the assest is packaged. Any shutdown work should also occur.

See Also:
Constant Field Values
Method Detail

execute

public org.eclipse.core.runtime.IStatus execute(IDefaultExportDataModel theExportDataModel,
                                                org.eclipse.core.runtime.IProgressMonitor theProgressMonitor)
Executes the task.

Parameters:
theExportDataModel - the data model that contains all the export settings needed for the task to perform it's part of the export operation.
theProgressMonitor - used to convey progress to the user for long running tasks.
Returns:
IStatus returns the status. The severity is
  • IStatus.OK if the task executed without any problems
  • IStatus.INFO if the task executed successfully but there were messages to report to the end user
  • IStatus.WARNING if the task executed successfully but there were either warnings or non-fatal errors reported.
  • IStatus.ERROR if there were errors during the execution of the task caused the export to be aborted.

getID

public String getID()
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.

Returns:
the ID of the task.

setID

public void setID(String theID)
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.

Parameters:
theID - of the task

getName

public String getName()
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.

Returns:
the name of the task.

setName

public void setName(String theName)
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.

Parameters:
theName - of the task.

getPriority

public int getPriority()
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.

Returns:
the priority of the task.

setPriority

public void setPriority(int thePriority)
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.

Parameters:
thePriority - of the task.

getProgressDescription

public String getProgressDescription()
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.

Returns:
the progress description of the task.

setProgressDescription

public void setProgressDescription(String theProgressDescription)
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.

Parameters:
theProgressDescription - of the task.

getType

public String getType()
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.

Returns:
the type of the task. The value will be one of the following

setType

public void setType(String theType)
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.

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.