com.sap.workspaces.module.extension

Class AbstractModuleLifecycle

java.lang.Object
  com.sap.workspaces.module.extension.AbstractModuleLifecycle

All Implemented Interfaces:

IWorkspacesService

public abstract class AbstractModuleLifecycle
extends Object
implements IWorkspacesService

Extend this class by implementing the callback methods invoked when the module is added to or removed from a workspace, or the module settings are changed

Since:

1.1

Constructor Summary

AbstractModuleLifecycle()

Method Summary

abstract void	onChangeSettings(IModuleContext moduleContext, ChangedSetting[] changedSettings) This callback is invoked when one or more settings of a module instance are modified.
abstract void	onCreate(IModuleContext context) This callback is invoked when a module instance is created and added to a workspace.
abstract void	onDelete(IModuleContext context) This callback is invoked before a module instance is removed from workspace.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractModuleLifecycle

public AbstractModuleLifecycle()

Method Detail

onCreate

public abstract void onCreate(IModuleContext context)
                       throws ModuleLifecycleException

This callback is invoked when a module instance is created and added to a workspace. Implement to initialize the module and its resources, if required.

Parameters:

context - the module context

Throws:

ModuleLifecycleException

onDelete

public abstract void onDelete(IModuleContext context)
                       throws ModuleLifecycleException

This callback is invoked before a module instance is removed from workspace. Implement to perform clean up of the module’s resources, if required.

Parameters:

context - the module context

Throws:

ModuleLifecycleException

onChangeSettings

public abstract void onChangeSettings(IModuleContext moduleContext,
                                      ChangedSetting[] changedSettings)
                               throws ModuleLifecycleException

This callback is invoked when one or more settings of a module instance are modified. Implement to perform any required actions.

Parameters:

moduleContext - the module context

changedSettings - An array of module settings that have been changed

Throws:

ModuleLifecycleException