IBM Rational Software Modeler
Release 6.0

com.ibm.xtools.ras.impord.rollback
Interface IRollbackManager


public interface IRollbackManager

Interface IRollbackManager manages instances of IRollbackAction to help rollback and cleanup when necessary. Note: This class/interface is part of an interim API that is still under development and expected to change significantly before reaching stability.


Method Summary
 IStatus finish(IProgressMonitor progressMonitor)
          Manager finalizes the rollback actions.
 boolean isRestartRecommended()
          Check if the Eclipse session is recommended for restart as a result of executing IRollackAction operations.
 boolean isRestartRequired()
          Check if the Eclipse session needs to be restarted as a result of executing IRollbackAction operations.
 IStatus register(IRollbackAction rollbackAction)
          Registers IRollbackAction instance in case a rollback/cleanup and the given action needs to be undone/cleaned up.
 IStatus rollback(IProgressMonitor progressMonitor)
          Manager rolls back all registered rollback actions by undoing the operations in the right order
 IStatus start()
          Manager starts by setting up resources to register rollback actions if necessary.
 

Method Detail

start

public IStatus start()
Manager starts by setting up resources to register rollback actions if necessary.

Returns:
status of start operation.

rollback

public IStatus rollback(IProgressMonitor progressMonitor)
Manager rolls back all registered rollback actions by undoing the operations in the right order

Parameters:
progressMonitor - to monitor progress of this operation.
Returns:
status of rollback operation.

finish

public IStatus finish(IProgressMonitor progressMonitor)
Manager finalizes the rollback actions. No rollback operations can be performed on after invoking finish()

Parameters:
progressMonitor - to monitor progress of this opeartion.
Returns:
status of finalize operation.

register

public IStatus register(IRollbackAction rollbackAction)
Registers IRollbackAction instance in case a rollback/cleanup and the given action needs to be undone/cleaned up.

Parameters:
rollbackAction - is the given IRollbackAction instance that potentially requires to be undone in case of rollback.
Returns:
IStatus for status of operation. IStatus can potentially have children, check status tree to get the full picture.

isRestartRequired

public boolean isRestartRequired()
Check if the Eclipse session needs to be restarted as a result of executing IRollbackAction operations.

Returns:
true if a restart of the eclipse session is needed.

isRestartRecommended

public boolean isRestartRecommended()
Check if the Eclipse session is recommended for restart as a result of executing IRollackAction operations.

Returns:
true if a restart of the eclipse session is recommended.

IBM Rational Software Modeler
Release 6.0


Guidelines for using Eclipse APIs.

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