com.filenet.wcm.apps.server.ui.info
Class HistoryInfoPage

java.lang.Object
  extended bycom.filenet.wcm.toolkit.server.base.WcmDpContainer
      extended bycom.filenet.wcm.toolkit.server.base.WcmModule
          extended bycom.filenet.wcm.toolkit.server.base.GlobalEventModule
              extended bycom.filenet.wcm.toolkit.server.base.WcmUiModule
                  extended bycom.filenet.wcm.toolkit.server.ui.WcmXSLModule
                      extended bycom.filenet.wcm.apps.server.ui.info.HistoryInfoPage
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmPanelInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface, com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface

public class HistoryInfoPage
extends com.filenet.wcm.toolkit.server.ui.WcmXSLModule
implements com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface

HistoryInfoPage shows the history for an object off of the info page. Only folders, custom objects and documents will have access to this page.


Field Summary
 
Fields inherited from class com.filenet.wcm.toolkit.server.ui.WcmXSLModule
transformUtil
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
HistoryInfoPage(java.lang.String sObjectType)
           
 
Method Summary
 java.lang.String getFormName()
          Returns form name
 void initialize()
           
 boolean isApplyButtonRequired()
          Implement, and return "true" if you want the WcmInfo container to show an "Apply" button.
 boolean isModified()
           
 void onClearFilter(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Call back triggered by the clear button.
 void onClearUser(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Call back triggered by clearing a user selection in the filter.
 void onCollapse(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          call back triggered from the collapse icon.
 void onExpand(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Call back triggered by the expandsion icon.
 void onGetUser(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Call back triggered from the return from the user selection page.
 void onInfoPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Call back to get the info page for update, delete, file and unfile events.
 void onQuery(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Call back triggered by the search button.
 void onSelectUser(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Call back triggered by a user selection in the filter.
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Initalizes the history state, builds the critria xml, Sets XSL Parameters.
 void panelFinish(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void panelSave(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          If the history page is expanded it saves off the history page in to the history state before the page is exited.
 void render(java.io.Writer w)
           
 
Methods inherited from class com.filenet.wcm.toolkit.server.ui.WcmXSLModule
convertToNodeList, getXML, getXSLParameter, renderXSL, setXML, setXML, setXML, setXML, setXSL, setXSLParameter, setXSLParameter, setXSLParameter, setXSLParameter, setXSLParameter, setXSLParameter
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmUiModule
getActive, getBasePath, getBaseUrl, getBaseURLBuilder, getControllerEventUrl, getControllerEventUrl, getEventFormFields, getEventFormFields, getEventFormTag, getEventFormTag, getEventUrl, getEventUrl, getEventUrl, getEventUrl, getFormSubmitUrl, getFormSubmitUrl, getGlobalEventUrl, getGlobalEventUrl, getPageUrl, getPageUrl, getPageUrl, getPageUrl, getUiParent, peekEvent, renderJSP, routeEvent, routeEvent, serverSideInclude, serverSideInclude, setActive, setJSP
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.GlobalEventModule
subscribeGlobalEvent
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
addChild, addChild, addChild, cleanup, debugTrace, getClassProperty, getClassProperty, getClassPropertyKeys, getConfiguration, getController, getDataStore, getModuleProperty, getModuleProperty, getModuleProperty, getModuleProperty, getModulePropertyKeys, getName, getParent, getWindowProperty, getWindowProperty, persist, queryDataProvider, setClassProperty, setClassProperty, setController, setModuleProperty, setModuleProperty, setName, setParent, setPortletParent, setWindowProperty
 
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmDpContainer
addDataProvider, addDataProvider
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
addDataProvider, cleanup, getDataStore, getModuleProperty, getName, getParent, persist, queryDataProvider, setController, setModuleProperty, setName, setParent
 

Constructor Detail

HistoryInfoPage

public HistoryInfoPage(java.lang.String sObjectType)
Method Detail

initialize

public void initialize()
                throws java.lang.Exception
Specified by:
initialize in interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
Throws:
java.lang.Exception

onStartPage

public void onStartPage(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Initalizes the history state, builds the critria xml, Sets XSL Parameters.

Specified by:
onStartPage in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Parameters:
request - HttpServletRequest is the Java™Server Pages (JSP) request object.
response - HttpServletResponse is the JSP response object.
Throws:
java.lang.Exception - If there were problems retrieving data.

onInfoPage

public void onInfoPage(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response)
                throws java.lang.Exception
Call back to get the info page for update, delete, file and unfile events.

Parameters:
request - HttpServletRequest is the jsp request object.
response - HttpServletResponse is the jsp response object.
Throws:
java.lang.Exception - If there were problems retrieving data.

getFormName

public java.lang.String getFormName()
Returns form name

Specified by:
getFormName in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface

panelSave

public void panelSave(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
               throws java.lang.Exception
If the history page is expanded it saves off the history page in to the history state before the page is exited.

Specified by:
panelSave in interface com.filenet.wcm.toolkit.server.base.WcmPanelInterface
Parameters:
request - HttpServletRequest is the jsp request object.
response - HttpServletResponse is the jsp response object.
Throws:
java.lang.Exception - If there were problems retrieving data.

onSelectUser

public void onSelectUser(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response)
                  throws java.lang.Exception
Call back triggered by a user selection in the filter.

Parameters:
request - HttpServletRequest is the jsp request object.
response - HttpServletResponse is the jsp response object.
Throws:
java.lang.Exception - If there were problems retrieving data.

onClearUser

public void onClearUser(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Call back triggered by clearing a user selection in the filter.

Parameters:
request - HttpServletRequest is the jsp request object.
response - HttpServletResponse is the jsp response object.
Throws:
java.lang.Exception - If there were problems retrieving data.

onGetUser

public void onGetUser(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
               throws java.lang.Exception
Call back triggered from the return from the user selection page.

Parameters:
request - HttpServletRequest is the jsp request object.
response - HttpServletResponse is the jsp response object.
Throws:
java.lang.Exception - If there were problems retrieving data.

onExpand

public void onExpand(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
Call back triggered by the expandsion icon.

Parameters:
request - HttpServletRequest is the jsp request object.
response - HttpServletResponse is the jsp response object.
Throws:
java.lang.Exception - If there were problems retrieving data.

onCollapse

public void onCollapse(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response)
                throws java.lang.Exception
call back triggered from the collapse icon.

Parameters:
request - HttpServletRequest is the jsp request object.
response - HttpServletResponse is the jsp response object.
Throws:
java.lang.Exception - If there were problems retrieving data.

render

public void render(java.io.Writer w)
            throws java.lang.Exception
Specified by:
render in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Throws:
java.lang.Exception

onQuery

public void onQuery(javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response)
             throws java.lang.Exception
Call back triggered by the search button.

Parameters:
request - HttpServletRequest is the jsp request object.
response - HttpServletResponse is the jsp response object.
Throws:
java.lang.Exception - If there were problems retrieving data.

onClearFilter

public void onClearFilter(javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response)
                   throws java.lang.Exception
Call back triggered by the clear button.

Parameters:
request - HttpServletRequest is the jsp request object.
response - HttpServletResponse is the jsp response object.
Throws:
java.lang.Exception - If there were problems retrieving data.

isModified

public boolean isModified()
                   throws java.lang.Exception
Specified by:
isModified in interface com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface
Throws:
java.lang.Exception

panelFinish

public void panelFinish(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Specified by:
panelFinish in interface com.filenet.wcm.toolkit.server.base.WcmPanelInterface
Throws:
java.lang.Exception

isApplyButtonRequired

public boolean isApplyButtonRequired()
                              throws java.lang.Exception
Implement, and return "true" if you want the WcmInfo container to show an "Apply" button. When Apply is pressed by the user, the UI module will get a call to wizardFinish.

Specified by:
isApplyButtonRequired in interface com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface
Throws:
java.lang.Exception


© Copyright IBM Corp. 2002, 2007. All Rights Reserved.