com.axemble.vdoc.sdk.document.extensions

Class BaseStorageResourceExtension

java.lang.Object

com.axemble.vdoc.sdk.document.extensions.BaseStorageResourceExtension

All Implemented Interfaces:

com.axemble.vdp.ui.core.document.extensions.IStorageResourceExtension, Serializable

public abstract class BaseStorageResourceExtension
extends Object
implements com.axemble.vdp.ui.core.document.extensions.IStorageResourceExtension

This base class provides direct access to the SDK API. The following methods are available: - getWorkflowModule() : the module to manipulate the workflow system; - getStorageResource() : the storage resource; - getResourceController() : the resource controller;

Version:

1.0, 25/06/2009

Author:

omenuel

See Also:

com.axemble.vdoc.sdk.modules.IWorkflowModule}, com.axemble.vdoc.sdk.modules.IStorageResource}, com.axemble.vdoc.sdk.modules.IResourceController}, Serialized Form

Constructor Summary

Constructors

Constructor and Description
BaseStorageResourceExtension()

Method Summary

Modifier and Type	Method and Description
protected IDirectoryModule	getDirectoryModule()
com.axemble.vdp.ui.core.document.CoreDocument	getDocument()
protected IPortalModule	getPortalModule()
protected IProjectModule	getProjectModule()
IResourceController	getResourceController() Retrieves the resource controller.
IStorageResource	getStorageResource() Retrieves the storage resource object.
IWorkflowModule	getWorkflowModule() Retrieves the workflow system object
void	init() This method is called when the extension is available.
void	init(com.axemble.vdp.ui.core.document.CoreDocument document)
boolean	isOnChangeSubscriptionOn(com.axemble.vdp.ui.core.document.fields.ICoreField field)
boolean	isOnChangeSubscriptionOn(IProperty property) This method is called for each property of the current form (workflow, task, action).
boolean	onAfterLoad()
boolean	onAfterSave()
boolean	onBeforeClose()
boolean	onBeforeLoad()
boolean	onBeforeSave()
void	onFieldChanged(com.axemble.vdp.ui.core.document.fields.ICoreField field)
void	onPropertyChanged(IProperty property) This method gets called each time the passed property has been changed
void	release()

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseStorageResourceExtension

public BaseStorageResourceExtension()

Method Detail

init

public final void init(com.axemble.vdp.ui.core.document.CoreDocument document)

Specified by:

init in interface com.axemble.vdp.ui.core.document.extensions.IStorageResourceExtension

init

public void init()

This method is called when the extension is available. It allows initialization of various specific members.

isOnChangeSubscriptionOn

public final boolean isOnChangeSubscriptionOn(com.axemble.vdp.ui.core.document.fields.ICoreField field)

Specified by:

isOnChangeSubscriptionOn in interface com.axemble.vdp.ui.core.document.extensions.IStorageResourceExtension

isOnChangeSubscriptionOn

public boolean isOnChangeSubscriptionOn(IProperty property)

This method is called for each property of the current form (workflow, task, action).

Parameters:

property - The property which has been loaded

Returns:

true if you wish to call back the server when the property gets changed, otherwise false

onAfterLoad

public boolean onAfterLoad()

Specified by:

onAfterLoad in interface com.axemble.vdp.ui.core.document.extensions.IStorageResourceExtension

onAfterSave

public boolean onAfterSave()

Specified by:

onAfterSave in interface com.axemble.vdp.ui.core.document.extensions.IStorageResourceExtension

onBeforeClose

public boolean onBeforeClose()

Specified by:

onBeforeClose in interface com.axemble.vdp.ui.core.document.extensions.IStorageResourceExtension

onBeforeLoad

public boolean onBeforeLoad()

Specified by:

onBeforeLoad in interface com.axemble.vdp.ui.core.document.extensions.IStorageResourceExtension

onBeforeSave

public boolean onBeforeSave()

Specified by:

onBeforeSave in interface com.axemble.vdp.ui.core.document.extensions.IStorageResourceExtension

onFieldChanged

public final void onFieldChanged(com.axemble.vdp.ui.core.document.fields.ICoreField field)

Specified by:

onFieldChanged in interface com.axemble.vdp.ui.core.document.extensions.IStorageResourceExtension

onPropertyChanged

public void onPropertyChanged(IProperty property)

This method gets called each time the passed property has been changed

Parameters:

property - The changed property

release

public void release()

Specified by:

release in interface com.axemble.vdp.ui.core.document.extensions.IStorageResourceExtension

getDocument

public final com.axemble.vdp.ui.core.document.CoreDocument getDocument()

Returns:

The CoreDocument representing the linked resource

getResourceController

public final IResourceController getResourceController()

Retrieves the resource controller.

Returns:

The IResourceController object

getStorageResource

public final IStorageResource getStorageResource()

Retrieves the storage resource object.

Returns:

The IStorageResource object.

getWorkflowModule

public final IWorkflowModule getWorkflowModule()

Retrieves the workflow system object

Returns:

the IWorkflowModule object.

getPortalModule

protected final IPortalModule getPortalModule()

Returns:

the portalModule

getDirectoryModule

protected final IDirectoryModule getDirectoryModule()

Returns:

the directoryModule

getProjectModule

protected final IProjectModule getProjectModule()

Returns:

the projectModule