|
IBM Rational Software Modeler Release 6.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
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 | |
IStatus |
execute(IDefaultExportDataModel theExportDataModel,
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 |
public static final String INITIALIZE
public static final String UPDATE
public static final String VALIDATE
public static final String FINALIZE
Method Detail |
public IStatus execute(IDefaultExportDataModel theExportDataModel, IProgressMonitor theProgressMonitor)
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.
IStatus.OK
if the task executed without any
problemsIStatus.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.public String getID()
public void setID(String theID)
theID
- of the taskpublic String getName()
public void setName(String theName)
theName
- of the task.public int getPriority()
public void setPriority(int thePriority)
thePriority
- of the task.public String getProgressDescription()
public void setProgressDescription(String theProgressDescription)
theProgressDescription
- of the task.public String getType()
public void setType(String theType)
theType
- of the task. The value should be one of the following
|
IBM Rational Software Modeler Release 6.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2004. All rights reserved.