Package com.axemble.vdoc.sdk.view.extensions

Class BaseViewExtension

java.lang.Object
com.axemble.vdoc.sdk.view.extensions.BaseViewExtension
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
FormattedNumberViewExtension
public abstract class BaseViewExtension extends Object implements Serializable
The BaseViewExtension class allows to override the behavior of a view.

The BaseViewExtension class provides direct access to the SDK API.

You can access the following methods:

  • getPortalModule() : the module to manipulate the back office system;
  • getDirectoryModule() : the module to manipulate the directory system;
  • getProjectModule() : the module to manipulate the project system;
  • getWorkflowModule() : the module to manipulate the workflow system;
Version:
1.0, 15/04/2004
Author:
vlygeros
See Also:

  • Field Details

    • LOGGER

      public static final com.axemble.vdp.utils.Logger LOGGER

  • Constructor Details

    • BaseViewExtension

      public BaseViewExtension()

  • Method Details

    • init

      public final void init(com.axemble.vdp.ui.framework.composites.base.CtlAbstractView view)

    • init

      public void init()
      This method is called when the extension is available. It allows initialization of various specific members.

    • 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

    • getResource

      protected final IResource getResource()
      Retrieves the container resource.
      Returns:
      The IResource object.

    • getResourceController

      protected final IResourceController getResourceController()
      Retrieves the associated resource controller.
      Returns:
      The IResourceController object.

    • getWorkflowInstance

      protected final IWorkflowInstance getWorkflowInstance()
      Retrieves the container workflow instance object.
      Returns:
      A IWorkflowInstance object if the container is a process document, null otherwise.

    • onPrepareView

      public boolean onPrepareView(com.axemble.vdp.views.query.Definition viewDefinition)

    • onPrepareColumns

      public void onPrepareColumns(List viewModelColumns)

    • onPrepareSQL

      public String onPrepareSQL(String sqlQuery)

    • onPrepareItemsInternal

      public final void onPrepareItemsInternal(com.axemble.vdp.ui.framework.composites.base.models.views.ViewModelItem viewModelItem, Serializable treatmentKey, Serializable resourceKey, Serializable activityKey, com.axemble.vdp.ui.core.document.CoreDocument resourceDocument)

    • onPrepareItem

      public abstract void onPrepareItem(ViewItem item)

    • onReady

      public boolean onReady()

    • getView

      protected final com.axemble.vdp.ui.framework.composites.base.CtlAbstractView getView()

    • getModel

      protected final com.axemble.vdp.ui.framework.composites.base.models.views.ICollectionViewModel getModel()

    • getSiteModule

      protected final ISiteModule getSiteModule()
      Returns:
      the siteModule