IBM Rational Software Modeler
Release 6.0

com.ibm.xtools.ras.profile.core
Interface IRASVersionUpdateService


public interface IRASVersionUpdateService

This interface is used to update asset manifests to the latest versions. This interface is not intended to be implemented by clients.


Method Summary
 IRASVersionUpdater[] getUpdaters(Document theManifest)
          Retrieves all the updaters need to update the document to the latest version.
 Document update(Document theManifest)
          This updates the document to the latest version.
 

Method Detail

update

public Document update(Document theManifest)
This updates the document to the latest version. It does this by looking at the hint to get the right updater. If no updater is found then it goes throught the updaters until we find an updater that supports the manifest. This is more expensive since all the plugins will be loaded. Once we find an updater we use it to do the update. If no updater is found then the original document is returned. This will handle all cases, except for manifest based on an unknown profile (for example one not registered with the service) that are based on an old version of a known profile. These profiles will not be updated, and thus when they are loaded by the known profile they will be in an old format which may thrown an exception at that time.

Parameters:
theManifest - the manifest to be updated
Returns:
the updated document

getUpdaters

public IRASVersionUpdater[] getUpdaters(Document theManifest)
Retrieves all the updaters need to update the document to the latest version. If the document is at the latest version as defined by the registered updaters, then an empty array is returned. It can be assumed that the updaters are ordered so that executing them in array order will update the document.

Parameters:
theManifest - the document to be updated
Returns:
the array of updaters

IBM Rational Software Modeler
Release 6.0


Guidelines for using Eclipse APIs.

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