com.filenet.wcm.apps.server.ui.operation
Class WcmLaunchOperation

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.WcmJSPModule
                      extended bycom.filenet.wcm.toolkit.server.ui.WcmLayoutModule
                          extended bycom.filenet.wcm.apps.server.ui.layout.WcmWorkplaceLayoutModule
                              extended bycom.filenet.wcm.apps.server.ui.operation.WcmLaunchOperation
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface

public class WcmLaunchOperation
extends WcmWorkplaceLayoutModule

The WcmLaunchOperation class displays the Workflow Subscription launch module. This class uses the WcmWorkflowLinksListView for displaying the main list of items.


Field Summary
 
Fields inherited from class com.filenet.wcm.apps.server.ui.layout.WcmWorkplaceLayoutModule
bannerModule, contextMenu, footerLinksBarModule, footerModule, leftCSSClass, MAIN_MODE, multiSelectMenu, OPERATION_MODE, renderLeftBar, showFooterLinksBar, tabBarModule, treeModule
 
Fields inherited from class com.filenet.wcm.toolkit.server.ui.WcmLayoutModule
jspMode, layout
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
WcmLaunchOperation()
           
 
Method Summary
 void cleanup()
          Cleans up session data to reduce resource usage.
 java.lang.String composeReturnUrl(com.filenet.wcm.toolkit.server.base.WcmController controller, java.lang.String returnUrl)
          Create the return url.
 WcmTextLinksBar getTextLinksBar()
          Accessor method to return the WcmTextLinksBar object.
 WcmWorkflowLinksListView getWorkflowLinksListView()
          Accessor method to return the WcmWorkflowLinksListView object.
 void initialize()
          Initializes data providers, the authoring state, and other state values.
 void onClose(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Handles the Exit Page event triggered by the controller.
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Handles the Start Page event triggered by the controller.
 
Methods inherited from class com.filenet.wcm.apps.server.ui.layout.WcmWorkplaceLayoutModule
addModule, addModule, addPrimaryPageAnchors, createLayout, getAnchorTree, getBannerBar, getFooter, getFooterLinksBar, getOperationTitle, getPageTabId, getPrimaryPageAnchors, getTabBar, isAdminLinkAvailable, registerAddedModules, renderLayout, resetPrimaryPageAnchors, setAddContextMenu, setMode, setOperationTitle, setOperationTitle, setOperationTitle, setOperationTitle, setRemoveTreeModule, setShowFooterLinksBar, setTabBarSelection
 
Methods inherited from class com.filenet.wcm.toolkit.server.ui.WcmLayoutModule
getLayout, render, setJSP
 
Methods inherited from class com.filenet.wcm.toolkit.server.ui.WcmJSPModule
getCurrentModule
 
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, getFormName, getFormSubmitUrl, getFormSubmitUrl, getGlobalEventUrl, getGlobalEventUrl, getPageUrl, getPageUrl, getPageUrl, getPageUrl, getUiParent, peekEvent, renderJSP, routeEvent, routeEvent, serverSideInclude, serverSideInclude, setActive
 
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, 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, getDataStore, getModuleProperty, getName, getParent, persist, queryDataProvider, setController, setModuleProperty, setName, setParent
 

Constructor Detail

WcmLaunchOperation

public WcmLaunchOperation()
Method Detail

initialize

public void initialize()
                throws java.lang.Exception
Initializes data providers, the authoring state, and other state values.

Specified by:
initialize in interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
Overrides:
initialize in class WcmWorkplaceLayoutModule
Throws:
java.lang.Exception - All errors.
See Also:
WcmAuthoringDataProvider, WcmEProcessDataProvider

onStartPage

public void onStartPage(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Handles the Start Page event triggered by the controller.

Data is retrieved from the controller and the cancel button bar is created.

Parameters:
request - The Java™Server Pages (JSP) request object.
response - The JSP response object.
Throws:
java.lang.Exception - All errors.

onClose

public void onClose(javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response)
             throws java.lang.Exception
Handles the Exit Page event triggered by the controller.

Data is retrieved from the controller and the cancel button bar is created.

Parameters:
request - The JSP request object.
response - The JSP response object.
Throws:
java.lang.Exception - All errors.

cleanup

public void cleanup()
             throws java.lang.Exception
Cleans up session data to reduce resource usage.

Throws:
java.lang.Exception - All errors.

getWorkflowLinksListView

public WcmWorkflowLinksListView getWorkflowLinksListView()
Accessor method to return the WcmWorkflowLinksListView object.

Returns:
WcmWorkflowLinksListView object.

getTextLinksBar

public WcmTextLinksBar getTextLinksBar()
Accessor method to return the WcmTextLinksBar object.

Returns:
WcmTextLinksBar object.

composeReturnUrl

public java.lang.String composeReturnUrl(com.filenet.wcm.toolkit.server.base.WcmController controller,
                                         java.lang.String returnUrl)
                                  throws java.lang.Exception
Create the return url. This url is typically used to re-enter the object information page with a StateChanged event.

Parameters:
controller - WcmController object.
returnUrl - String current return url.
Returns:
String Return url which includes the required event parameters.
Throws:
java.lang.Exception


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