|
IBM Rational Software Modeler Release 6.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface holds all the data needed to import a RAS asset. It represents the model part of the model-view-controller implementation of the RAS import 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 | |
void |
addToOverwriteList(String filename)
Add to the list of files that can be overwritten by the import service if necessary |
void |
clearOverwriteList()
Clear the list of files that can be overwritten by the import service |
void |
clearTargetProjectLocations()
Clear the "project name" <=>"target project location" mapping maintained in the data model. |
void |
close()
Closes and releases all resources being held by the data model. |
Boolean |
getAcceptAllLicenses()
Checks if all licences have been accepted by the import data model client. |
IImportLicenseModel[] |
getAllLicenses(org.eclipse.core.runtime.IProgressMonitor progressMonitor)
Retrieve licenses associated with the artifacts pacakged in the asset. |
Asset |
getAsset(org.eclipse.core.runtime.IProgressMonitor progressMonitor)
Retrieve the Asset for this data model. |
String |
getAssetPath()
Retrieve the asset path. |
String[] |
getDeployableFeaturesInAsset(org.eclipse.core.runtime.IProgressMonitor progressMonitor)
Retreves the deployable features contained in the asset. |
String[] |
getDeployablePluginsInAsset(org.eclipse.core.runtime.IProgressMonitor progressMonitor)
Retrieves the deployable plugins/fragments contained in the asset. |
String |
getDeployablesInstallSite()
Retrieve the installation location for deployable features and plugins. |
String |
getImportStatusLog()
Retrieve the status log file associated with the import of this asset if one exists. |
Artifact |
getManifestArtifact()
Retrieve the asset's manifest Artifact if possible.
|
String |
getManifestFolder()
Retreives the manifest folder path. |
List |
getOverwriteList()
|
Boolean |
getOverwriteWithoutPromptingOption()
Retrieve the overwrite silently option. |
String[] |
getProjectsInAsset(org.eclipse.core.runtime.IProgressMonitor progressMonitor)
Retrieves the projects contained in the asset. |
IRelatedAssetManager |
getRelatedAssetManager(org.eclipse.core.runtime.IProgressMonitor progressMonitor)
Get the IRelatedAssetManager associated with an
Asset |
Boolean |
getSaveManifestOption()
Retrieves the save manifest option. |
String |
getTargetFolder()
Retrieve the target folder path. |
String |
getTargetProjectLocation()
Retrieve the target project location. |
String |
getTargetProjectLocation(String projectName)
Retrieve the target project location for the project identified by the projectName. |
org.eclipse.swt.widgets.Shell |
getUIContext()
Retrieve the UI context for import operations. |
void |
removeTargetProjectLocation(String projectName)
Remove the target project file path for the project identified by projectName. |
void |
setAcceptAllLicenses(boolean theOption)
Accept all the licenses associated with the artifacts packaged with the asset. |
void |
setAssetPath(String assetPath)
Set the asset file path for the import data model. |
void |
setDeployablesInstallSite(String siteName)
Set the installation location to the given site on the local filesystem for deploying features and plugins. |
void |
setManifestFolder(String thePath)
Set the folder path where the manifest will be stored in. |
void |
setOverwriteWithoutPromptingOption(boolean theOption)
Set the overwrite silently option. |
void |
setSaveManifestOption(boolean theOption)
Set the save manifest option. |
void |
setTargetFolder(String thePath)
Set the target folder path. |
void |
setTargetProjectLocation(String thePath)
Set the target project file path. |
void |
setTargetProjectLocation(String projectName,
String thePath)
Set the target project file path for only the project identified by projectName. |
void |
setUIContext(org.eclipse.swt.widgets.Shell shell)
Set the UI context for import operations. |
org.eclipse.core.runtime.IStatus |
validateAll(org.eclipse.core.runtime.IProgressMonitor progressMonitor)
Validates the properties of the data model to determine if it's in a state acceptable to the import service. |
Methods inherited from interface com.ibm.xtools.ras.core.data.IDataModel |
addDataModelListener, containsProperty, getProperty, getPropertyAsBoolean, getPropertyAsInteger, getPropertyAsString, removeDataModelListener, removeProperty, setProperty, setProperty, setProperty |
Method Detail |
public void setAssetPath(String assetPath)
assetPath
- the asset file pathpublic String getAssetPath()
null
if it doesn't exist.public Asset getAsset(org.eclipse.core.runtime.IProgressMonitor progressMonitor)
Asset
for this data model.
progressMonitor
- to monitor progress of getting the asset.
getAsset()
could be long running if a large
asset is being retrieved the first time.
public Artifact getManifestArtifact()
Artifact
if possible.
Manifest artifacts are tagged with activity type
ImportActivityTaskTypes.SAVE_MANIFEST
to aid retrieval.
Artifact
or null
if
nothing is found.public IRelatedAssetManager getRelatedAssetManager(org.eclipse.core.runtime.IProgressMonitor progressMonitor)
IRelatedAssetManager
associated with an
Asset
progressMonitor
- to monitor progress of getting the related asset manager for
this asset. getRelatedAssetManager
could be
long running especially the first time it is invoked on large
assets.
public String getImportStatusLog()
public String getTargetFolder()
null
if it doesn't
exist.public void setTargetFolder(String thePath)
thePath
- the target folder path
NullPointerException
- if thePath is null
public String getTargetProjectLocation()
null
if it doesn't
exist.public String getTargetProjectLocation(String projectName)
projectName
- for the project whose target location is being retrieved.
null
if it doesn't
exist.public void setTargetProjectLocation(String thePath)
thePath
- the target project file path/location.
NullPointerException
- if thePath is null
public void setTargetProjectLocation(String projectName, String thePath)
setTargetProjectLocation(String thePath)
.
projectName
- identifies the project to associate with the path/location.thePath
- the target project file path/location.clearTargetProjectLocations()
public void removeTargetProjectLocation(String projectName)
projectName
- name of the project which is being disassociated with a
project locationpublic void clearTargetProjectLocations()
public String getDeployablesInstallSite()
null
if it does not
exist.public void setDeployablesInstallSite(String siteName)
siteName
- is the given installation location.public String[] getProjectsInAsset(org.eclipse.core.runtime.IProgressMonitor progressMonitor)
progressMonitor
- to monitor progress of the getProjectsInAsset
.
It could potentially be long-running, especially when invoked
for the first time.
null
if no
asset has been specified in the data model.public String[] getDeployablePluginsInAsset(org.eclipse.core.runtime.IProgressMonitor progressMonitor)
progressMonitor
- to monitor progress of this method as it can potentially
validate the asset.
null
if no asset has been specified in the data
model.public String[] getDeployableFeaturesInAsset(org.eclipse.core.runtime.IProgressMonitor progressMonitor)
progressMonitor
- to monitor progress of this method as it can potentially
validate the asset.
null
if no asset has been specified in the data
model.public IImportLicenseModel[] getAllLicenses(org.eclipse.core.runtime.IProgressMonitor progressMonitor)
progressMonitor
- to monitor progress of this method as it can potentially
validate the asset.
IImportLicenseModel
.public void setAcceptAllLicenses(boolean theOption)
theOption
- set to true
to accept licenses, else set to
false.public Boolean getAcceptAllLicenses()
true
if all the licenses have been accepted,
otherwise return false
.public Boolean getSaveManifestOption()
getPropertyAsBoolean(ImportDataModelConstants.OPTION_SAVE_MANIFEST)
public void setSaveManifestOption(boolean theOption)
setProperty(ImportDataModelConstants.OPTION_SAVE_MANIFEST, theOption)
theOption
- the save manifest optionpublic String getManifestFolder()
getProperty(ImportDataModelConstants.MANIFEST_PATH)
public void setManifestFolder(String thePath)
setProperty(ImportDataModelConstants.MANIFEST_PATH, theOption)
thePath
- representing the manifest folder path.public Boolean getOverwriteWithoutPromptingOption()
getPropertyAsBoolean(ImportDataModelConstants.OPTION_OVERWRITE_WITHOUT_PROMPTING)
public void setOverwriteWithoutPromptingOption(boolean theOption)
setProperty(ImportDataModelConstants.OPTION_OVERWRITE_WITHOUT_PROMPTING, theOption)
theOption
- the overwrite silently optionpublic void addToOverwriteList(String filename)
filename
- is a full path name to the file that can be overwritten by the
import service if necessary.public void clearOverwriteList()
public List getOverwriteList()
public org.eclipse.core.runtime.IStatus validateAll(org.eclipse.core.runtime.IProgressMonitor progressMonitor)
progressMonitor
- to monitor progress of validate data model operation. The
validate operation could be long running for large assets.
IStatus
that holds the status code and status
messages if anypublic void setUIContext(org.eclipse.swt.widgets.Shell shell)
shell
- is the org.eclipse.swt.widgets.Shell
context
under which any user interaction takes place or
null
if there isn't any.public org.eclipse.swt.widgets.Shell getUIContext()
org.eclipse.swt.widgets.Shell
or null
if it was not set.public void close()
|
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.