com.axemble.vdoc.sdk.document.extensions

Class BaseDocumentExtension

java.lang.Object

com.axemble.vdoc.sdk.document.extensions.BaseDocumentExtension

All Implemented Interfaces:

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

public abstract class BaseDocumentExtension
extends Object
implements com.axemble.vdp.ui.core.document.extensions.IDocumentExtension

This base class provides direct access to the SDK API. It implements IDocumentExtension interface.

The following methods are available:

• getWorkflowModule() : the module to manipulate the workflow system;
• getWorkflowInstance() : the workflow instance;
• getResourceController() : the resource controller;

Version:

1.0, 15/04/2008

Author:

vlygeros

See Also:

IWorkflowModule, IWorkflowInstance, IResourceController, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static com.axemble.vdp.utils.Logger	LOGGER

Constructor Summary

Constructors

Constructor and Description
BaseDocumentExtension()

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.
IWorkflowInstance	getWorkflowInstance() Retrieves the main workflow instance object.
IWorkflowModule	getWorkflowModule() Retrieves the workflow module 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	onAfterCancelDelegation()
boolean	onAfterDelegate()
boolean	onAfterDelegateTaskOnly()
void	onAfterFieldChanged(com.axemble.vdp.ui.core.document.fields.ICoreField field)
boolean	onAfterLoad()
void	onAfterPropertyChanged(IProperty property)
boolean	onAfterRefuseDelegation()
boolean	onAfterSave()
boolean	onAfterSendInformation()
boolean	onAfterSubmit(IAction action) After submit event
boolean	onAfterSubmit(IStorageKey actionKey)
boolean	onBeforeAbort()
boolean	onBeforeCancelDelegation()
boolean	onBeforeClose()
boolean	onBeforeDelegate()
boolean	onBeforeDelegateTaskOnly()
boolean	onBeforeLoad()
boolean	onBeforeRefuseDelegation()
boolean	onBeforeRemind()
boolean	onBeforeSave()
boolean	onBeforeSendInformation()
boolean	onBeforeSubmit(IAction action) Before submit event
boolean	onBeforeSubmit(IStorageKey actionKey)
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

Field Detail

LOGGER

protected static com.axemble.vdp.utils.Logger LOGGER

Constructor Detail

BaseDocumentExtension

public BaseDocumentExtension()

Method Detail

onBeforeRemind

public boolean onBeforeRemind()

Specified by:

onBeforeRemind in interface com.axemble.vdp.ui.core.document.extensions.IDocumentExtension

init

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

Specified by:

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

init

public void init()

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

isOnChangeSubscriptionOn

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

Specified by:

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

isOnChangeSubscriptionOn

public boolean isOnChangeSubscriptionOn(IProperty property)

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

Parameters:

property - The loaded property

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.IDocumentExtension

onAfterSave

public boolean onAfterSave()

Specified by:

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

onAfterSubmit

public boolean onAfterSubmit(IStorageKey actionKey)

Specified by:

onAfterSubmit in interface com.axemble.vdp.ui.core.document.extensions.IDocumentExtension

onBeforeAbort

public boolean onBeforeAbort()

Specified by:

onBeforeAbort in interface com.axemble.vdp.ui.core.document.extensions.IDocumentExtension

onBeforeClose

public boolean onBeforeClose()

Specified by:

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

onBeforeLoad

public boolean onBeforeLoad()

Specified by:

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

onBeforeSave

public boolean onBeforeSave()

Specified by:

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

onBeforeSubmit

public boolean onBeforeSubmit(IAction action)

Before submit event

Parameters:

action - The workflow action pressed by the logged on user

Returns:

true if everything went right, otherwise false.

onAfterSubmit

public boolean onAfterSubmit(IAction action)

After submit event

Parameters:

action - The workflow action pressed by the logged on user

Returns:

true if everything went right, otherwise false.

onBeforeSubmit

public boolean onBeforeSubmit(IStorageKey actionKey)

Specified by:

onBeforeSubmit in interface com.axemble.vdp.ui.core.document.extensions.IDocumentExtension

onFieldChanged

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

Specified by:

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

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.IDocumentExtension

getDocument

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

Returns:

The CoreDocument representing the main workflow instance

getResourceController

public IResourceController getResourceController()

Retrieves the resource controller.

Returns:

The IResourceController object

getWorkflowInstance

public IWorkflowInstance getWorkflowInstance()

Retrieves the main workflow instance object.

Returns:

The IWorkflowInstance object.

getWorkflowModule

public IWorkflowModule getWorkflowModule()

Retrieves the workflow module 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

onBeforeCancelDelegation

public boolean onBeforeCancelDelegation()

Specified by:

onBeforeCancelDelegation in interface com.axemble.vdp.ui.core.document.extensions.IDocumentExtension

onBeforeDelegate

public boolean onBeforeDelegate()

Specified by:

onBeforeDelegate in interface com.axemble.vdp.ui.core.document.extensions.IDocumentExtension

onBeforeDelegateTaskOnly

public boolean onBeforeDelegateTaskOnly()

Specified by:

onBeforeDelegateTaskOnly in interface com.axemble.vdp.ui.core.document.extensions.IDocumentExtension

onBeforeRefuseDelegation

public boolean onBeforeRefuseDelegation()

Specified by:

onBeforeRefuseDelegation in interface com.axemble.vdp.ui.core.document.extensions.IDocumentExtension

onBeforeSendInformation

public boolean onBeforeSendInformation()

Specified by:

onBeforeSendInformation in interface com.axemble.vdp.ui.core.document.extensions.IDocumentExtension

onAfterCancelDelegation

public boolean onAfterCancelDelegation()

Specified by:

onAfterCancelDelegation in interface com.axemble.vdp.ui.core.document.extensions.IDocumentExtension

onAfterDelegate

public boolean onAfterDelegate()

Specified by:

onAfterDelegate in interface com.axemble.vdp.ui.core.document.extensions.IDocumentExtension

onAfterDelegateTaskOnly

public boolean onAfterDelegateTaskOnly()

Specified by:

onAfterDelegateTaskOnly in interface com.axemble.vdp.ui.core.document.extensions.IDocumentExtension

onAfterRefuseDelegation

public boolean onAfterRefuseDelegation()

Specified by:

onAfterRefuseDelegation in interface com.axemble.vdp.ui.core.document.extensions.IDocumentExtension

onAfterSendInformation

public boolean onAfterSendInformation()

Specified by:

onAfterSendInformation in interface com.axemble.vdp.ui.core.document.extensions.IDocumentExtension

onAfterFieldChanged

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

Specified by:

onAfterFieldChanged in interface com.axemble.vdp.ui.core.document.extensions.IDocumentExtension

onAfterPropertyChanged

public void onAfterPropertyChanged(IProperty property)