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

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

public class WcmConfirmOperation
extends WcmWorkplaceLayoutModule


Field Summary
protected  WcmAuthoringState authorState
           
protected  com.filenet.wcm.toolkit.server.util.prefs.PrefsLabel classLabel
           
protected  java.lang.String className
           
protected  com.filenet.wcm.toolkit.server.base.WcmController controller
           
protected  java.lang.String convertForWeb
           
protected  java.lang.String displayCompoundDocError
           
protected  boolean displayWorkflowTitle
           
protected  java.lang.String filePlan
           
protected  java.lang.String folderName
           
protected  java.lang.String launchWorkflow
           
protected  int mode
           
static int MODE_ADD
           
static int MODE_CFW
           
static int MODE_CHECKIN
           
static int MODE_CLASSIFYRECORD
           
static int MODE_DECLARERECORD
           
static int MODE_ET_ADD
           
static int MODE_ET_CHECKIN
           
static int MODE_FORM_ADD
           
static int MODE_LAUNCH
           
static int MODE_LINK
           
static int MODE_RT_ADD
           
static int MODE_RT_CHECKIN
           
static int MODE_SEARCH
           
protected  WcmNavigationState naviState
           
protected  java.lang.String objectId
           
protected  java.lang.String objectLabel
           
protected  java.lang.String objectStoreName
           
protected  java.lang.String recordClassName
           
protected  java.lang.String returnUrl
           
protected  WcmSummaryModule summaryModule
           
protected  java.lang.String title
           
protected  java.lang.String turnOffRT
           
protected  int type
           
protected  java.lang.String workflowName
           
protected static com.filenet.wcm.toolkit.util.WcmString wsAddCompoundDocumentMessage
           
protected static com.filenet.wcm.toolkit.util.WcmString wsAddedAndDeclaredSucceeded
           
protected static com.filenet.wcm.toolkit.util.WcmString wsAddSucceeded
           
protected static com.filenet.wcm.toolkit.util.WcmString wsAddTitle
           
protected static com.filenet.wcm.toolkit.util.WcmString wsCheckinCompoundDocumentMessage
           
protected static com.filenet.wcm.toolkit.util.WcmString wsCheckinSucceeded
           
protected static com.filenet.wcm.toolkit.util.WcmString wsCheckinTitle
           
protected static com.filenet.wcm.toolkit.util.WcmString wsChkInAndDeclaredSucceeded
           
protected static com.filenet.wcm.toolkit.util.WcmString wsClassifyRecordSucceeded
           
protected static com.filenet.wcm.toolkit.util.WcmString wsCompoundDocumentMessage
           
protected static com.filenet.wcm.toolkit.util.WcmString wsConvertForWebMessage
           
protected static com.filenet.wcm.toolkit.util.WcmString wsCustomClassLabel
           
protected static com.filenet.wcm.toolkit.util.WcmString wsDeclareAsRecordMessage
           
protected static com.filenet.wcm.toolkit.util.WcmString wsDeclareRecordSucceeded
           
protected static com.filenet.wcm.toolkit.util.WcmString wsDeclareTitle
           
protected static com.filenet.wcm.toolkit.util.WcmString wsDocClassLabel
           
protected static com.filenet.wcm.toolkit.util.WcmString wsFileName
           
protected static com.filenet.wcm.toolkit.util.WcmString wsFolderClassLabel
           
protected static com.filenet.wcm.toolkit.util.WcmString wsFolderLabel
           
protected static com.filenet.wcm.toolkit.util.WcmString wsLaunched
           
protected static com.filenet.wcm.toolkit.util.WcmString wsLaunchMessage
           
protected static com.filenet.wcm.toolkit.util.WcmString wsLaunchTitle
           
protected static com.filenet.wcm.toolkit.util.WcmString wsLinkClassLabel
           
protected static com.filenet.wcm.toolkit.util.WcmString wsLinkFrom
           
protected static com.filenet.wcm.toolkit.util.WcmString wsLinkSucceeded
           
protected static com.filenet.wcm.toolkit.util.WcmString wsLinkTo
           
protected static com.filenet.wcm.toolkit.util.WcmString wsNone
           
protected static com.filenet.wcm.toolkit.util.WcmString wsNotDefined
           
protected static com.filenet.wcm.toolkit.util.WcmString wsOKMessage
           
protected static com.filenet.wcm.toolkit.util.WcmString wsOperationSucceeded
           
protected static com.filenet.wcm.toolkit.util.WcmString wsParentFolderLabel
           
protected static com.filenet.wcm.toolkit.util.WcmString wsRecordClassLabel
           
protected static com.filenet.wcm.toolkit.util.WcmString wsSearched
           
protected static com.filenet.wcm.toolkit.util.WcmString wsSearchTitle
           
protected static com.filenet.wcm.toolkit.util.WcmString wsTitle
           
protected static com.filenet.wcm.toolkit.util.WcmString wsWorkflowName
           
 
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
WcmConfirmOperation()
           
 
Method Summary
protected  void addLinksBar()
           
protected  boolean autoLaunchWorkflow()
          Launch workflow from background without prompting user UI.
 void cleanup()
          Clean it up
protected  void configureSummary()
          Writes the actual contents of the status bar.
protected  java.lang.String getCompoundDocumentErrorMessage()
           
 void initialize()
           
 void onAddToWeb(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Exit form page
 void onDeclareAsRecord(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Declare document as record
 void onLaunch(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Event handler for the Launch command.
 void onOK(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Exit confirmation page.
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Configures the WcmConfirmation page
 void render(java.io.Writer w)
           
protected  java.lang.String selectPrompt(int type, int mode)
           
 
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, 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
 

Field Detail

MODE_ADD

public static final int MODE_ADD
See Also:
Constant Field Values

MODE_CHECKIN

public static final int MODE_CHECKIN
See Also:
Constant Field Values

MODE_LAUNCH

public static final int MODE_LAUNCH
See Also:
Constant Field Values

MODE_SEARCH

public static final int MODE_SEARCH
See Also:
Constant Field Values

MODE_ET_ADD

public static final int MODE_ET_ADD
See Also:
Constant Field Values

MODE_ET_CHECKIN

public static final int MODE_ET_CHECKIN
See Also:
Constant Field Values

MODE_RT_ADD

public static final int MODE_RT_ADD
See Also:
Constant Field Values

MODE_RT_CHECKIN

public static final int MODE_RT_CHECKIN
See Also:
Constant Field Values

MODE_DECLARERECORD

public static final int MODE_DECLARERECORD
See Also:
Constant Field Values

MODE_FORM_ADD

public static final int MODE_FORM_ADD
See Also:
Constant Field Values

MODE_CFW

public static final int MODE_CFW
See Also:
Constant Field Values

MODE_LINK

public static final int MODE_LINK
See Also:
Constant Field Values

MODE_CLASSIFYRECORD

public static final int MODE_CLASSIFYRECORD
See Also:
Constant Field Values

wsTitle

protected static final com.filenet.wcm.toolkit.util.WcmString wsTitle

wsAddTitle

protected static final com.filenet.wcm.toolkit.util.WcmString wsAddTitle

wsCheckinTitle

protected static final com.filenet.wcm.toolkit.util.WcmString wsCheckinTitle

wsLaunchTitle

protected static final com.filenet.wcm.toolkit.util.WcmString wsLaunchTitle

wsSearchTitle

protected static final com.filenet.wcm.toolkit.util.WcmString wsSearchTitle

wsDeclareTitle

protected static final com.filenet.wcm.toolkit.util.WcmString wsDeclareTitle

wsDocClassLabel

protected static final com.filenet.wcm.toolkit.util.WcmString wsDocClassLabel

wsFolderClassLabel

protected static final com.filenet.wcm.toolkit.util.WcmString wsFolderClassLabel

wsLinkClassLabel

protected static final com.filenet.wcm.toolkit.util.WcmString wsLinkClassLabel

wsCustomClassLabel

protected static final com.filenet.wcm.toolkit.util.WcmString wsCustomClassLabel

wsRecordClassLabel

protected static final com.filenet.wcm.toolkit.util.WcmString wsRecordClassLabel

wsFolderLabel

protected static final com.filenet.wcm.toolkit.util.WcmString wsFolderLabel

wsParentFolderLabel

protected static final com.filenet.wcm.toolkit.util.WcmString wsParentFolderLabel

wsNone

protected static final com.filenet.wcm.toolkit.util.WcmString wsNone

wsWorkflowName

protected static final com.filenet.wcm.toolkit.util.WcmString wsWorkflowName

wsNotDefined

protected static final com.filenet.wcm.toolkit.util.WcmString wsNotDefined

wsOKMessage

protected static final com.filenet.wcm.toolkit.util.WcmString wsOKMessage

wsConvertForWebMessage

protected static final com.filenet.wcm.toolkit.util.WcmString wsConvertForWebMessage

wsLaunchMessage

protected static final com.filenet.wcm.toolkit.util.WcmString wsLaunchMessage

wsDeclareAsRecordMessage

protected static final com.filenet.wcm.toolkit.util.WcmString wsDeclareAsRecordMessage

wsFileName

protected static final com.filenet.wcm.toolkit.util.WcmString wsFileName

wsAddedAndDeclaredSucceeded

protected static final com.filenet.wcm.toolkit.util.WcmString wsAddedAndDeclaredSucceeded

wsChkInAndDeclaredSucceeded

protected static final com.filenet.wcm.toolkit.util.WcmString wsChkInAndDeclaredSucceeded

wsAddSucceeded

protected static final com.filenet.wcm.toolkit.util.WcmString wsAddSucceeded

wsLinkSucceeded

protected static final com.filenet.wcm.toolkit.util.WcmString wsLinkSucceeded

wsCheckinSucceeded

protected static final com.filenet.wcm.toolkit.util.WcmString wsCheckinSucceeded

wsDeclareRecordSucceeded

protected static final com.filenet.wcm.toolkit.util.WcmString wsDeclareRecordSucceeded

wsClassifyRecordSucceeded

protected static final com.filenet.wcm.toolkit.util.WcmString wsClassifyRecordSucceeded

wsLaunched

protected static final com.filenet.wcm.toolkit.util.WcmString wsLaunched

wsSearched

protected static final com.filenet.wcm.toolkit.util.WcmString wsSearched

wsOperationSucceeded

protected static final com.filenet.wcm.toolkit.util.WcmString wsOperationSucceeded

wsLinkFrom

protected static final com.filenet.wcm.toolkit.util.WcmString wsLinkFrom

wsLinkTo

protected static final com.filenet.wcm.toolkit.util.WcmString wsLinkTo

wsCompoundDocumentMessage

protected static final com.filenet.wcm.toolkit.util.WcmString wsCompoundDocumentMessage

wsAddCompoundDocumentMessage

protected static final com.filenet.wcm.toolkit.util.WcmString wsAddCompoundDocumentMessage

wsCheckinCompoundDocumentMessage

protected static final com.filenet.wcm.toolkit.util.WcmString wsCheckinCompoundDocumentMessage

summaryModule

protected WcmSummaryModule summaryModule

controller

protected com.filenet.wcm.toolkit.server.base.WcmController controller

returnUrl

protected java.lang.String returnUrl

authorState

protected WcmAuthoringState authorState

naviState

protected WcmNavigationState naviState

objectStoreName

protected java.lang.String objectStoreName

className

protected java.lang.String className

folderName

protected java.lang.String folderName

objectId

protected java.lang.String objectId

title

protected java.lang.String title

objectLabel

protected java.lang.String objectLabel

convertForWeb

protected java.lang.String convertForWeb

launchWorkflow

protected java.lang.String launchWorkflow

workflowName

protected java.lang.String workflowName

turnOffRT

protected java.lang.String turnOffRT

filePlan

protected java.lang.String filePlan

recordClassName

protected java.lang.String recordClassName

mode

protected int mode

type

protected int type

displayWorkflowTitle

protected boolean displayWorkflowTitle

displayCompoundDocError

protected java.lang.String displayCompoundDocError

classLabel

protected com.filenet.wcm.toolkit.server.util.prefs.PrefsLabel classLabel
Constructor Detail

WcmConfirmOperation

public WcmConfirmOperation()
Method Detail

initialize

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

selectPrompt

protected java.lang.String selectPrompt(int type,
                                        int mode)
                                 throws java.lang.Exception
Throws:
java.lang.Exception

getCompoundDocumentErrorMessage

protected java.lang.String getCompoundDocumentErrorMessage()
                                                    throws java.lang.Exception
Throws:
java.lang.Exception

onStartPage

public void onStartPage(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Configures the WcmConfirmation page

Parameters:
request - The Java™Server Pages (JSP) request object HttpServletRequest
response - The JSP response object HttpServletResponse
Throws:
java.lang.Exception - If there are problems retrieving data.

onOK

public void onOK(javax.servlet.http.HttpServletRequest request,
                 javax.servlet.http.HttpServletResponse response)
          throws java.lang.Exception
Exit confirmation page. Test to see if we are using an Entry Template with a Workflow andd attempt to launch it if necessary.

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.

autoLaunchWorkflow

protected boolean autoLaunchWorkflow()
                              throws java.lang.Exception
Launch workflow from background without prompting user UI.

Returns:
boolean - Whether Workflow is launch
Throws:
java.lang.Exception

onAddToWeb

public void onAddToWeb(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response)
                throws java.lang.Exception
Exit form page

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.

onDeclareAsRecord

public void onDeclareAsRecord(javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.HttpServletResponse response)
                       throws java.lang.Exception
Declare document as record

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.

onLaunch

public void onLaunch(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
Event handler for the Launch command.

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.

configureSummary

protected void configureSummary()
                         throws java.lang.Exception
Writes the actual contents of the status bar.

Throws:
java.lang.Exception - If there are problems retrieving data.

addLinksBar

protected void addLinksBar()
                    throws java.lang.Exception
Throws:
java.lang.Exception

render

public void render(java.io.Writer w)
            throws java.lang.Exception
Throws:
java.lang.Exception

cleanup

public void cleanup()
             throws java.lang.Exception
Clean it up

Throws:
java.lang.Exception


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