lumis.doui.table
Class BaseTableDataProcessActionHandler

Package class diagram package BaseTableDataProcessActionHandler
java.lang.Object
  extended by lumis.doui.processaction.ProcessActionHandler<TableSource>
      extended by lumis.doui.table.BaseTableDataProcessActionHandler
All Implemented Interfaces:
IProcessActionHandler, IParameters
Direct Known Subclasses:
DocumentSelectProcessActionHandler, ImageSelectProcessActionHandler, TableAddDataProcessActionHandler, TableDeleteDataProcessActionHandler, TableUpdateDataProcessActionHandler

@StableMinor(version="4.1",
             sinceVersion="4.0")
public abstract class BaseTableDataProcessActionHandler
extends ProcessActionHandler<TableSource>

Base class for table data process action handlers. This class offers some utility methods for the table data process action handlers implementations.

Since:
4.0.0

Field Summary
 
Fields inherited from class lumis.doui.processaction.ProcessActionHandler
douiContext, localizationManager, parameters, processActionContainer, processActionNode, RESPONSE_TYPE_CLOSE_WINDOW, RESPONSE_TYPE_HYPERLINK, RESPONSE_TYPE_MESSAGE, RESPONSE_TYPE_POPUP_INTERFACE, RESPONSE_TYPE_PREVIEW, RESPONSE_TYPE_REFRESH_PARENT, RESPONSE_TYPE_REQUEST_PROCESS_ACTION_CONFIRMATION_MESSAGE, RESPONSE_TYPE_REQUEST_PROCESS_ACTION_CONFIRMATION_PROCESS_ACTION_ID, RESPONSE_TYPE_RUN_JAVASCRIPT, RESPONSE_TYPE_SET_REQUEST_ATTRIBUTES, RESPONSE_TYPE_SET_REQUEST_PARAMETERS, RESPONSE_TYPE_SET_RESPONSE_PARAMETERS, RESPONSE_TYPE_STANDARD_COMMIT, RESPONSE_TYPE_STANDARD_EMBEDDED, RESPONSE_TYPE_STANDARD_POPUP, RESPONSE_TYPE_VALIDATE_PROCESS_ACTION_ON_RENDER, sessionConfig, source, sourceContainer, transaction
 
Constructor Summary
BaseTableDataProcessActionHandler()
           
 
Method Summary
protected  void addToIndex()
           
protected  QueryBuilder createQueryBuilder()
           
protected  IPortalEvent createRenderDataChangedEvent(Object itemId)
          Creates a render data changed event.
protected  DouiIndexConfig getIndexConfig()
           
protected  void indexData()
           
protected  boolean isSearchEnabled()
           
protected  TabularData readSelectedData()
          Reads the data selected by the user from the persistence and returns it.
protected  void removeFromIndex()
           
protected  void sendRenderDataChangedNotification(Object itemId)
          Notifies observers that the render data may have changed.
protected  boolean shouldSendRenderDataChangedNotification()
          Indicates if this process action should send render data changed notification.
 
Methods inherited from class lumis.doui.processaction.ProcessActionHandler
addDefaultResponse, addResponseParameter, checkServiceInstancePermission, checkServiceInstancePermission, getParameter, getParameter, getResource, getServiceInterfaceHyperLink, getUrl, init, localize, processHyperLinkResponse, processPopupInterfaceResponse, resolveFieldValueNode, setParameter
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface lumis.doui.processaction.IProcessActionHandler
processAction
 

Constructor Detail

BaseTableDataProcessActionHandler

public BaseTableDataProcessActionHandler()
Method Detail

createQueryBuilder

protected QueryBuilder createQueryBuilder()
                                   throws PortalException
Throws:
PortalException

readSelectedData

protected TabularData readSelectedData()
                                throws PortalException
Reads the data selected by the user from the persistence and returns it. The data selected by the user is identified by the primary key field parameter values.

Returns:
the data selected by the user.
Throws:
PortalException
Since:
4.0.3
See Also:
TableSource#readData(String[], lumis.util.ITransaction)}

createRenderDataChangedEvent

protected IPortalEvent createRenderDataChangedEvent(Object itemId)
                                             throws PortalException
Creates a render data changed event. Called by sendRenderDataChangedNotification(Object).

Parameters:
itemId - the itemId parameter value for the event.
Returns:
the event.
Throws:
PortalException
Since:
4.1.0

sendRenderDataChangedNotification

protected void sendRenderDataChangedNotification(Object itemId)
                                          throws PortalException
Notifies observers that the render data may have changed.

Throws:
PortalException
Since:
4.1.0

addToIndex

protected void addToIndex()
                   throws PortalException
Throws:
PortalException

removeFromIndex

protected void removeFromIndex()
                        throws PortalException
Throws:
PortalException

isSearchEnabled

protected boolean isSearchEnabled()

getIndexConfig

protected DouiIndexConfig getIndexConfig()
                                  throws PortalException
Throws:
PortalException

indexData

protected void indexData()
                  throws PortalException
Throws:
PortalException

shouldSendRenderDataChangedNotification

protected boolean shouldSendRenderDataChangedNotification()
                                                   throws PortalException
Indicates if this process action should send render data changed notification.

Returns:
true if it should, false otherwise.
Throws:
PortalException
Since:
4.1.0


Lumisportal  4.1.0.071221 - Copyright © 2001-2007, Lumis. All Rights Reserved.