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

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.WcmMultiPanelModule
                      extended bycom.filenet.wcm.toolkit.server.ui.WcmMultiPanelViewModule
                          extended bycom.filenet.wcm.apps.server.ui.WcmInfoModule
                              extended bycom.filenet.wcm.apps.server.ui.info.WcmQueueInfo
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface

public class WcmQueueInfo
extends WcmInfoModule

Displays the Information page for the eProcess queue items. The class displays tabbed pages for the detailed queue list. The class instantiates the WcmQueuePropsInfoPage and the WcmAttachmentInfoPage classes to display the particular pages.


Field Summary
 
Fields inherited from class com.filenet.wcm.apps.server.ui.WcmInfoModule
actionButtons, bannerModule, collapseInstructions, config, controller, displayDefaultButtons, footerLinksBarModule, footerModule, HideApplyButton, instructionsModule, instructionsText, isPrimaryTitle, layout, pathModule, renderBannerModule, renderFooterLinksBarModule, renderFooterModule, renderTopTabBarModule, renderTreeView, sitePrefs, sObjectTypeLabel, textLinksBarModule, titleBarModule, topTabBarModule, treeModule, viewsNode, wsClickApply, wsClickSelectProperties
 
Fields inherited from class com.filenet.wcm.toolkit.server.ui.WcmMultiPanelViewModule
modified, MODIFIED_FLAGS_KEY
 
Fields inherited from class com.filenet.wcm.toolkit.server.ui.WcmMultiPanelModule
currentModule, currentPanel, currentPanelNumber, panelList
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
NAME_DELIMITER
 
Constructor Summary
WcmQueueInfo()
           
 
Method Summary
 WcmAttachmentInfoPage getAttachmentInfoPage()
          Accessor method to return the WcmAttachmentInfoPage object.
 WcmQueuePropsInfoPage getQueuePropsInfoPage()
          Accessor method to return the WcmQueuePropsInfoPage object.
 void initialize()
          Initializes the class data.
 void onComplete(com.filenet.wcm.toolkit.server.util.event.GlobalEvent e)
          Handles the Complete event triggered by the user returning from the processor page.
 void onExit(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Clears any cached data associated with work item.
 void onMove(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Makes calls to the eProcess Data Provider to move the selected queue item from the public queue into the user's inbox.
 void onReassign(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Changes the participant responsible for processing the current step.
 void onReassigned(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Handles the Reassigned event triggered by the user reassigned the step.
 void onReturnToSender(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Makes calls to the eProcess Data Provider to move the selected queue item from the user queue back into the queue from witch it was sent from.
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Adds the appropriate command button to the toolbar.
 void render(java.io.Writer w)
          Renders the tab bar, instructions text, path view, toolbar, selected panel and the button bar.
 
Methods inherited from class com.filenet.wcm.apps.server.ui.WcmInfoModule
addActionButton, addActionButton, addActionButtons, addApplyButton, addDefaultButtons, addFooterModules, addPanelSelectionAnchor, addSelectPropertiesButton, addTabBar, configRootViewsNode, configureTreeView, getDefaultInstructionsMode, getPathView, onCollapse, onExpand, setCurrentPanelSelection, setDefaultInstructionsMode, setDisplayDefaultButtons, setExitLinkText, setHideApplyButton, setInstructionsText, setInstructionsText, setMultiPanelModuleTitle, setMultiPanelModuleTitle, setPath, setPath, setPath, setRenderBannerModule, setRenderFooterLinksBarModule, setRenderFooterModule, setRenderTopTabBarModule, setRenderTreeView, setRootNodeLabel, setTopTabBarLinks
 
Methods inherited from class com.filenet.wcm.toolkit.server.ui.WcmMultiPanelViewModule
getCurrentViewPanel, isPanelModified, onApply, selectPanel, setPanelModified
 
Methods inherited from class com.filenet.wcm.toolkit.server.ui.WcmMultiPanelModule
addPanel, addPanel, addPanel, addPanel, getCurrentModule, getCurrentPanel, getFormName, getModule, getMultiPanelModuleTitle, getMultiPanelModuleTitleString, getPanel, onSelectPanel, selectPanel, setMultiPanelModuleTitle, setMultiPanelModuleTitle
 
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

WcmQueueInfo

public WcmQueueInfo()
Method Detail

initialize

public void initialize()
                throws java.lang.Exception
Initializes the class data. It gathers the necessary data from the controller that specifies which queue item to display information, and instantiates the classes required to display the particular pages.

Specified by:
initialize in interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
Overrides:
initialize in class WcmInfoModule
Throws:
java.lang.Exception - If there are problems.

onStartPage

public void onStartPage(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Adds the appropriate command button to the toolbar.

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

render

public void render(java.io.Writer w)
            throws java.lang.Exception
Description copied from class: WcmInfoModule
Renders the tab bar, instructions text, path view, toolbar, selected panel and the button bar.

Specified by:
render in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Overrides:
render in class WcmInfoModule
Parameters:
w - Writer object
Throws:
java.lang.Exception - If any errors occur

onMove

public void onMove(javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)
            throws java.lang.Exception
Makes calls to the eProcess Data Provider to move the selected queue item from the public queue into the user's inbox.

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

onReturnToSender

public void onReturnToSender(javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response)
                      throws java.lang.Exception
Makes calls to the eProcess Data Provider to move the selected queue item from the user queue back into the queue from witch it was sent from.

Parameters:
request - The JSP request object HttpServletRequest
response - The JSP response object HttpServletResponse
Throws:
java.lang.Exception

onReassign

public void onReassign(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response)
                throws java.lang.Exception
Changes the participant responsible for processing the current step.

Parameters:
request - The JSP request object HttpServletRequest
response - The JSP response object HttpServletResponse
Throws:
java.lang.Exception

onReassigned

public void onReassigned(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response)
                  throws java.lang.Exception
Handles the Reassigned event triggered by the user reassigned the step.

Parameters:
request - The JSP request object HttpServletRequest
response - The JSP response object HttpServletResponse
Throws:
java.lang.Exception

onComplete

public void onComplete(com.filenet.wcm.toolkit.server.util.event.GlobalEvent e)
                throws java.lang.Exception
Handles the Complete event triggered by the user returning from the processor page.

Throws:
java.lang.Exception

onExit

public void onExit(javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response)
            throws java.lang.Exception
Clears any cached data associated with work item.

Parameters:
request - The JSP request object HttpServletRequest
response - The JSP response object HttpServletResponse
Throws:
java.lang.Exception

getQueuePropsInfoPage

public WcmQueuePropsInfoPage getQueuePropsInfoPage()
Accessor method to return the WcmQueuePropsInfoPage object.

Returns:
WcmQueuePropsInfoPage object.

getAttachmentInfoPage

public WcmAttachmentInfoPage getAttachmentInfoPage()
Accessor method to return the WcmAttachmentInfoPage object.

Returns:
WcmAttachmentInfoPage object.


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