IBM Rational Software Modeler
Release 6.0

com.ibm.xtools.ras.export
Interface IExportService


public interface IExportService

The primary interface used to perform the export of a RAS asset. It is not intended to be implemented by clients.


Method Summary
 IStatus performExport(IDefaultExportDataModel theExportDataModel, IProgressMonitor theProgressMonitor)
          Performs the export by processing all registered export tasks.
 

Method Detail

performExport

public IStatus performExport(IDefaultExportDataModel theExportDataModel,
                             IProgressMonitor theProgressMonitor)
Performs the export by processing all registered export tasks.

Parameters:
theExportDataModel - the data model that contains all the export settings needed for the export service to perform the export operation.
theProgressMonitor - an optional progress monitor that will be used to track the progress of the export. Set this to null if no progress tracking is necessary.
Returns:
IStatus the status object that tells us if the export went ok
  • IStatus.OK if the export executed without any problems
  • IStatus.INFO if the export executed successfully, but there were messages to report to the end user
  • IStatus.WARNING if the export executed successfully, but there were either warnings or non-fatal errors reported.
  • IStatus.ERROR if there were errors during the execution of the export that caused the export to be aborted.
It's possible that the IStatus object has more than one status associated with it. It may be necessary to check if it has children.

IBM Rational Software Modeler
Release 6.0


Guidelines for using Eclipse APIs.

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