com.filenet.wcm.apps.server.ui.operation.author
Class CancelCheckoutOperation

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.author.CancelCheckoutOperation
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface

public class CancelCheckoutOperation
extends WcmWorkplaceLayoutModule

This module displays the metadata for a selected document with the intention of allowing the user to perform a Cancel Checkout on that document. If for whatever reason, the user cannot perform the cancel checkout or something fails, the user will be alerted with the proper error message.


Nested Class Summary
 class CancelCheckoutOperation.CancelCheckoutFileManagement
           
 
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
CancelCheckoutOperation()
           
 
Method Summary
 void cleanup()
           
 void initialize()
          Creates the objects needed to display the path, navigation, and list views.
 void onClose(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Even handler for when close button is clicked
 void onSelect(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Event handler for when an object is selected.
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          The default event handler sets up the display objects for rendering.
 
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

CancelCheckoutOperation

public CancelCheckoutOperation()
Method Detail

initialize

public void initialize()
                throws java.lang.Exception
Creates the objects needed to display the path, navigation, and list views. Object creation determined by the mode set: simple or complex.

Specified by:
initialize in interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
Overrides:
initialize in class WcmWorkplaceLayoutModule
Throws:
java.lang.Exception
See Also:
WcmObjectStoreNavigation

onStartPage

public void onStartPage(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
The default event handler sets up the display objects for rendering.

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

onClose

public void onClose(javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response)
             throws java.lang.Exception
Even handler for when close button is clicked

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

onSelect

public void onSelect(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
Event handler for when an object is selected.

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

cleanup

public void cleanup()
             throws java.lang.Exception
Throws:
java.lang.Exception


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