|
IBM Rational Software Modeler Release 6.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Represents the unit of work that gets executed during the import by the RAS import engine .
Use the execute
method to import the data model that
contains all import settings and retrieves the status of the import activity.
To set the type of the task, use the setType
method. To
retrieve the type of the task use the getType
method. To set
or retrieve the name of the task, use the setName
and
getName
methods.
Field Summary | |
static int |
PRIORITY_MAX
The maximum value of the priority attribute is 100. |
static int |
PRIORITY_MIN
The mininum value of the priority attribute is 0. |
static String |
TYPE_EXTRACT
The extract import process task. |
static String |
TYPE_FINALIZE
The finalize import process task. |
static String |
TYPE_INITIALIZE
The initialize import process task. |
static String |
TYPE_UPDATE
The update import process task. |
Method Summary | |
IStatus |
execute(IImportDataModel theImportDataModel,
IAuxiliaryImportServices auxiliaryImportServices,
IProgressMonitor progressMonitor)
Executes the task. |
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. |
Field Detail |
public static final String TYPE_INITIALIZE
public static final String TYPE_EXTRACT
public static final String TYPE_UPDATE
public static final String TYPE_FINALIZE
public static final int PRIORITY_MIN
public static final int PRIORITY_MAX
Method Detail |
public IStatus execute(IImportDataModel theImportDataModel, IAuxiliaryImportServices auxiliaryImportServices, IProgressMonitor progressMonitor)
Executes the task.
theImportDataModel
- The data model that contains all import settings.auxiliaryImportServices
- is the set of auxiliary services required to perform the
operation. This parameter may be null
if no
auxiliary services are needed.progressMonitor
- The progress monitor that provides progress indication and
cancel capability.
The return values are:
public String getName()
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
setName
method.
public void setName(String taskName)
The name is called by the import framework automatically.
taskName
- The name that corresponds to the name attribute in the
importEngineTask extension.public String getID()
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
setID
method to set the task ID.
public void setID(String taskID)
The ID is called by the import framework automatically.
taskID
- The task ID that corresponds to the ID attribute in the
importEngineTask extension.public String getType()
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
setType
method.
The return values are:
public void setType(String taskType)
The task type is called by the import framework automatically. The type of the task can have the following values:
taskType
- The type of the task that corresponds to the type attribute in
the importEngineTask extension.public int getPriority()
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
setPriority
method to set the priority of the task.
The return value has a range of 0..100.
public void setPriority(int taskPriority)
The priority values can have a range of 0..100. It is called by the import framework automatically.
taskPriority
- The task priority that corresponds to the priority attribute
in the importEngineTask extension.public String getProgressDescription()
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.
public void setProgressDescription(String taskProgressDescription)
It is called by the import framework automatically.
taskProgressDescription
- The task progress description that corresponds to the progress
description attribute in the importEngineTask extension.
|
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.