IBM Rational Software Modeler
Release 6.0

com.ibm.xtools.ras.impord.engine.tasks
Interface IImportEngineTask

All Known Implementing Classes:
AbstractImportEngineTask

public interface IImportEngineTask

Represents the unit of work that gets executed during the import by the RAS import engine .

Use the executemethod 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 setTypemethod. To retrieve the type of the task use the getTypemethod. To set or retrieve the name of the task, use the setNameand getNamemethods.

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
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

TYPE_INITIALIZE

public static final String TYPE_INITIALIZE
The initialize import process task.

See Also:
Constant Field Values

TYPE_EXTRACT

public static final String TYPE_EXTRACT
The extract import process task.

See Also:
Constant Field Values

TYPE_UPDATE

public static final String TYPE_UPDATE
The update import process task.

See Also:
Constant Field Values

TYPE_FINALIZE

public static final String TYPE_FINALIZE
The finalize import process task.

See Also:
Constant Field Values

PRIORITY_MIN

public static final int PRIORITY_MIN
The mininum value of the priority attribute is 0.

See Also:
Constant Field Values

PRIORITY_MAX

public static final int PRIORITY_MAX
The maximum value of the priority attribute is 100.

See Also:
Constant Field Values
Method Detail

execute

public IStatus execute(IImportDataModel theImportDataModel,
                       IAuxiliaryImportServices auxiliaryImportServices,
                       IProgressMonitor progressMonitor)

Executes the task.

Parameters:
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.
Returns:
Returns the status of the import.

The return values are:

  • IStatus.OK - If the task was executed without any problems.
  • IStatus.INFO - If the task was executed, but there are messages to report to the end user.
  • IStatus.WARNING - If the task was executed, but there are warnings reported or non-fatal errors. Import continues.
  • IStatus.ERROR - If there are errors during the execution of the task. The import is aborted.


getName

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 setNamemethod.

Returns:
Returns the name of the task.

setName

public void setName(String taskName)
Sets the name of the task.

The name is called by the import framework automatically.

Parameters:
taskName - The name that corresponds to the name attribute in the importEngineTask extension.

getID

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 setIDmethod to set the task ID.

Returns:
Returns the ID of the task.

setID

public void setID(String taskID)
Sets the unique identifier (ID) of the task.

The ID is called by the import framework automatically.

Parameters:
taskID - The task ID that corresponds to the ID attribute in the importEngineTask extension.

getType

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 setTypemethod.

Returns:
Returns the type of the task.

The return values are:


setType

public void setType(String taskType)
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:

Parameters:
taskType - The type of the task that corresponds to the type attribute in the importEngineTask extension.

getPriority

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 setPrioritymethod to set the priority of the task.

Returns:
Returns the priority of the task.

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


setPriority

public void setPriority(int taskPriority)
Sets the priority of the task.

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

Parameters:
taskPriority - The task priority that corresponds to the priority attribute in the importEngineTask extension.

getProgressDescription

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.

Returns:
Returns the progress description of the task.

setProgressDescription

public void setProgressDescription(String taskProgressDescription)
Sets the progress description of the task.

It is called by the import framework automatically.

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.