IBM Rational Software Modeler
Release 6.0

com.ibm.xtools.ras.export.data
Interface IDefaultExportDataModel

All Superinterfaces:
IDataModel
All Known Subinterfaces:
IDefaultComponentExportDataModel, IDefaultWebserviceExportDataModel

public interface IDefaultExportDataModel
extends IDataModel

This interface holds all the data needed to export a RAS asset using the default profile. It represents the model part of the model-view-controller implementation of the RAS export service. Although it can be, it's not intended to be implemented by clients.


Field Summary
 
Fields inherited from interface com.ibm.xtools.ras.core.data.IDataModel
NULL
 
Method Summary
 Asset getAsset()
          Retrieves the Asset representing the profile for the export data model.
 String getAssetWriter()
          Retrieves the asset writer ID.
 IRASAssetWriter getAssetWriterInstance()
          Retrieves the asset writer instance representing the writer format returned by getAssetWriter().
 Boolean getOverwriteExisting()
          Retrieves whether or not the export model is configured to overwrite existing resouces discovered during the export process.
 IRelatedAssetManager getRelatedAssetManager()
          Retrieves the IRelatedAssetManager used to manage the direct and indirect related assets contained within the Asset being exported.
 String getTargetFileSystemPath()
          Retrieves the asset file system target path.
 boolean isNewAsset()
          Determines if the export data model is using an Asset that was created by the data model or if it is one that was passed to the export data model when it was constructed.
 void setAssetTargetPath(String targetPath)
          Set the asset's target file system path.
 void setAssetWriter(String writerID)
          Sets the asset writer ID.
 void setOverwriteExisting(boolean overwriteExisting)
          Sets the property indicating if existing resources should be overwritten during the export process.
 IStatus validateAll()
          Validates the entire data model to determine if the model is ready for export.
 IStatus validateProperty(String thePropertyName)
          Validates the property to see if it is ready for the export.
 
Methods inherited from interface com.ibm.xtools.ras.core.data.IDataModel
addDataModelListener, containsProperty, getProperty, getPropertyAsBoolean, getPropertyAsInteger, getPropertyAsString, registerValidator, removeDataModelListener, removeProperty, setProperty, setProperty, setProperty, unregisterValidator, validateAll, validateProperty
 

Method Detail

validateAll

public IStatus validateAll()
Validates the entire data model to determine if the model is ready for export.

Returns:
IStatus the status object that holds the status code and any messages

validateProperty

public IStatus validateProperty(String thePropertyName)
                         throws IllegalArgumentException
Validates the property to see if it is ready for the export.

Parameters:
thePropertyName - the name of the property to validate
Returns:
IStatus the status object that holds the status code and any messages
Throws:
IllegalArgumentException - if thePropertyName is null

getAsset

public Asset getAsset()
Retrieves the Asset representing the profile for the export data model. It may be left null prior to using the export data model in an export operation. If so, a new Asset is created during the export operation.

Returns:
the asset representing the profile for the export data model or null if the model doesn't contain an asset.

isNewAsset

public boolean isNewAsset()
Determines if the export data model is using an Asset that was created by the data model or if it is one that was passed to the export data model when it was constructed.

Returns:
true if the Asset was created by the data model

getRelatedAssetManager

public IRelatedAssetManager getRelatedAssetManager()
Retrieves the IRelatedAssetManager used to manage the direct and indirect related assets contained within the Asset being exported.

Returns:
the related asset manager used to mange the related assets contained directly or indirectly in the Asset being exported

getTargetFileSystemPath

public String getTargetFileSystemPath()
Retrieves the asset file system target path. Identical to getPropertyAsString(ExportDataModelConstants.ASSET_TARGET_PATH).

Returns:
the asset target file system path or null if it doesn't exist

setAssetTargetPath

public void setAssetTargetPath(String targetPath)
                        throws IllegalArgumentException
Set the asset's target file system path. Identical to setProperty(ExportDataModelConstants.ASSET_TARGET_PATH, targetPath).

Parameters:
targetPath - the file system location where the export service is expected to place it's output.
Throws:
IllegalArgumentException - if the targetPath is null.

getAssetWriter

public String getAssetWriter()
Retrieves the asset writer ID. Identical to getPropertyAsString(ExportDataModelConstants.ASSET_WRITER_ID).

Returns:
the asset writer id or null if it doesn't exist.

getAssetWriterInstance

public IRASAssetWriter getAssetWriterInstance()
Retrieves the asset writer instance representing the writer format returned by getAssetWriter(). This will be null until opened during the export process by the open asset writer task in the finalization phase of the export. Tasks that wish to access the writer should join the export process during the finalization phase and specify a priority lower than 95.

Returns:
the asset writer instance representing the writer format returned by getAssetWriter().

setAssetWriter

public void setAssetWriter(String writerID)
                    throws IllegalArgumentException
Sets the asset writer ID. This is the ID of the writer that should be used to package the asset. Identical to setProperty(ExportDataModelConstants.ASSET_WRITER_ID, writerID).

Parameters:
writerID - the ID representing the asset writer
Throws:
IllegalArgumentException - if the writer ID is null.

getOverwriteExisting

public Boolean getOverwriteExisting()
Retrieves whether or not the export model is configured to overwrite existing resouces discovered during the export process. Identical to getPropertyAsBoolean(ExportDataModelConstants.OVERWRITE_EXISTING).

Returns:
the Boolean indicating whether existing resources should be overwritten during the export process or null if it doesn't exist

setOverwriteExisting

public void setOverwriteExisting(boolean overwriteExisting)
Sets the property indicating if existing resources should be overwritten during the export process. Identical to setProperty(ExportDataModelConstants.OVERWRITE_EXISTING, overwriteExisting).

Parameters:
overwriteExisting - boolean flag indicating whether existing resources should be overwritten during the export process.

IBM Rational Software Modeler
Release 6.0


Guidelines for using Eclipse APIs.

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