com.filenet.wcm.apps.server.ui.wizard
Class EntryDesignerRecordsWizardPage

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.apps.server.ui.wizard.EntryDesignerRecordsWizardPage
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmPanelInterface, com.filenet.wcm.toolkit.server.base.WcmPanelValidationInterface, com.filenet.wcm.toolkit.server.base.WcmSequencePanelInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface

public class EntryDesignerRecordsWizardPage
extends com.filenet.wcm.toolkit.server.base.WcmUiModule
implements com.filenet.wcm.toolkit.server.base.WcmSequencePanelInterface, com.filenet.wcm.toolkit.server.base.WcmPanelValidationInterface


Nested Class Summary
 class EntryDesignerRecordsWizardPage.SelectTemplate
          Special class created to override the base class to add other useful methods.
 
Field Summary
static int ALWAYS_DECLARE
           
protected  com.filenet.wcm.toolkit.server.dp.WcmAuthoringDataProvider authoringDataProvider
           
protected  WcmAuthoringState authorState
           
static int CAN_CLASSIFY
           
static int CANNOT_CLASSIFY
           
protected  ChoicePage choicePage
           
protected  com.filenet.wcm.toolkit.util.WcmString[] choices
           
static int CLASSIFY_DECLARE
           
static int CLASSIFY_OPTIONALLY
           
protected  com.filenet.wcm.toolkit.server.util.prefs.PrefsLabel classLabel
           
protected  WcmWorkplaceConfig config
           
protected static java.lang.String FORM_NAME
           
protected  java.util.Locale locale
           
protected static java.lang.String MODULE_NAME
           
static int NEVER_DECLARE
           
static int NOT_INTIALIZED
           
static int OPTIONALY_DECLARE
           
protected  com.filenet.wcm.toolkit.server.dp.RecordsManageDataProvider recordsManageDataProvider
           
protected  EntryDesignerRecordsWizardPage.SelectTemplate selectRecordTemplate
           
protected  int type
           
protected static com.filenet.wcm.toolkit.util.WcmString wsAlwaysMsg
           
protected static com.filenet.wcm.toolkit.util.WcmString wsBrowseTemplate
           
static com.filenet.wcm.toolkit.util.WcmString wsClassifyAlwaysDeclare
           
static com.filenet.wcm.toolkit.util.WcmString wsClassifyNever
           
static com.filenet.wcm.toolkit.util.WcmString wsClassifyOptionalClassify
           
static com.filenet.wcm.toolkit.util.WcmString wsClassifyOptionalDeclare
           
static com.filenet.wcm.toolkit.util.WcmString wsClassifyOptionally
           
protected static com.filenet.wcm.toolkit.util.WcmString wsClassifyRecord
           
static com.filenet.wcm.toolkit.util.WcmString wsDeclareAlways
           
static com.filenet.wcm.toolkit.util.WcmString wsDeclareNever
           
static com.filenet.wcm.toolkit.util.WcmString wsDeclareOptionally
           
protected static com.filenet.wcm.toolkit.util.WcmString wsDisplay
           
static com.filenet.wcm.toolkit.util.WcmString wsNeverDeclare
           
protected static com.filenet.wcm.toolkit.util.WcmString wsOptionalyMsg
           
protected static com.filenet.wcm.toolkit.util.WcmString wsRemove
           
protected static com.filenet.wcm.toolkit.util.WcmString wsSelectedTemplate
           
protected static com.filenet.wcm.toolkit.util.WcmString wsSelectTemplate
           
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
NAME_DELIMITER
 
Constructor Summary
EntryDesignerRecordsWizardPage(int type)
           
 
Method Summary
static com.filenet.wcm.toolkit.util.WcmString convertClassifyBehavior(int value, boolean chap4)
           
static int convertClassifyBehavior(java.lang.String value)
           
protected  com.filenet.wcm.toolkit.util.WcmString findChoice(java.lang.String value)
           
 java.lang.String getFormName()
           
 java.util.Iterator getValidationErrors()
           
 void initialize()
          Initializes data providers, XSL parameters, the authoring state, and other state values.
 boolean isFinished()
          Indicates if the input is complete.
 void onClearObject(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Handles the ClearObject event.
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          The default event sets up the display objects for rendering.
 void panelCancel(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Clears state information.
 void panelFinish(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Normally not called directly since this page should never show the Finish button.
 void panelInit()
          Called when this wizard page is first loaded to clear out any residual state information.
 void panelSave(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Called to save the state of the page.
 boolean panelValidate()
          Called on a page to check any entered data to confirm that everything is valid.
 void render(java.io.Writer w)
          Renders the folder navigation hierarchy.
 
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
 

Field Detail

wsDeclareAlways

public static final com.filenet.wcm.toolkit.util.WcmString wsDeclareAlways

wsDeclareOptionally

public static final com.filenet.wcm.toolkit.util.WcmString wsDeclareOptionally

wsDeclareNever

public static final com.filenet.wcm.toolkit.util.WcmString wsDeclareNever

wsClassifyAlwaysDeclare

public static final com.filenet.wcm.toolkit.util.WcmString wsClassifyAlwaysDeclare

wsClassifyOptionalDeclare

public static final com.filenet.wcm.toolkit.util.WcmString wsClassifyOptionalDeclare

wsClassifyOptionalClassify

public static final com.filenet.wcm.toolkit.util.WcmString wsClassifyOptionalClassify

wsClassifyOptionally

public static final com.filenet.wcm.toolkit.util.WcmString wsClassifyOptionally

wsClassifyNever

public static final com.filenet.wcm.toolkit.util.WcmString wsClassifyNever

wsNeverDeclare

public static final com.filenet.wcm.toolkit.util.WcmString wsNeverDeclare

ALWAYS_DECLARE

public static final int ALWAYS_DECLARE
See Also:
Constant Field Values

OPTIONALY_DECLARE

public static final int OPTIONALY_DECLARE
See Also:
Constant Field Values

CLASSIFY_DECLARE

public static final int CLASSIFY_DECLARE
See Also:
Constant Field Values

CLASSIFY_OPTIONALLY

public static final int CLASSIFY_OPTIONALLY
See Also:
Constant Field Values

NEVER_DECLARE

public static final int NEVER_DECLARE
See Also:
Constant Field Values

NOT_INTIALIZED

public static final int NOT_INTIALIZED
See Also:
Constant Field Values

CANNOT_CLASSIFY

public static final int CANNOT_CLASSIFY
See Also:
Constant Field Values

CAN_CLASSIFY

public static final int CAN_CLASSIFY
See Also:
Constant Field Values

MODULE_NAME

protected static final java.lang.String MODULE_NAME
See Also:
Constant Field Values

FORM_NAME

protected static final java.lang.String FORM_NAME
See Also:
Constant Field Values

wsSelectedTemplate

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

wsSelectTemplate

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

wsBrowseTemplate

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

wsDisplay

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

wsAlwaysMsg

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

wsClassifyRecord

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

wsOptionalyMsg

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

wsRemove

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

authoringDataProvider

protected com.filenet.wcm.toolkit.server.dp.WcmAuthoringDataProvider authoringDataProvider

recordsManageDataProvider

protected com.filenet.wcm.toolkit.server.dp.RecordsManageDataProvider recordsManageDataProvider

choicePage

protected ChoicePage choicePage

type

protected int type

authorState

protected WcmAuthoringState authorState

config

protected WcmWorkplaceConfig config

selectRecordTemplate

protected EntryDesignerRecordsWizardPage.SelectTemplate selectRecordTemplate

locale

protected java.util.Locale locale

classLabel

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

choices

protected com.filenet.wcm.toolkit.util.WcmString[] choices
Constructor Detail

EntryDesignerRecordsWizardPage

public EntryDesignerRecordsWizardPage(int type)
                               throws java.lang.Exception
Method Detail

initialize

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

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
The default event sets up the display objects for rendering.

Specified by:
onStartPage in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Parameters:
request - HttpServletRequest object
response - HttpServletResponse object
Throws:
java.lang.Exception

convertClassifyBehavior

public static int convertClassifyBehavior(java.lang.String value)

convertClassifyBehavior

public static com.filenet.wcm.toolkit.util.WcmString convertClassifyBehavior(int value,
                                                                             boolean chap4)

render

public void render(java.io.Writer w)
            throws java.lang.Exception
Renders the folder navigation hierarchy.

Specified by:
render in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Parameters:
w - Writer object to write to.
Throws:
java.lang.Exception

panelInit

public void panelInit()
               throws java.lang.Exception
Called when this wizard page is first loaded to clear out any residual state information.

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

panelCancel

public void panelCancel(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Clears state information.

Specified by:
panelCancel in interface com.filenet.wcm.toolkit.server.base.WcmSequencePanelInterface
Parameters:
request - HttpServletRequest object
response - HttpServletResponse object
Throws:
java.lang.Exception

panelSave

public void panelSave(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
               throws java.lang.Exception
Called to save the state of the page.

Specified by:
panelSave in interface com.filenet.wcm.toolkit.server.base.WcmPanelInterface
Parameters:
request - HttpServletRequest object
response - HttpServletResponse object
Throws:
java.lang.Exception

panelValidate

public boolean panelValidate()
                      throws java.lang.Exception
Called on a page to check any entered data to confirm that everything is valid.

Specified by:
panelValidate in interface com.filenet.wcm.toolkit.server.base.WcmPanelValidationInterface
Returns:
boolean indicate if validate success or not.
Throws:
java.lang.Exception

onClearObject

public void onClearObject(javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response)
                   throws java.lang.Exception
Handles the ClearObject event.

Parameters:
request - Request object.
response - Response object.
Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.

panelFinish

public void panelFinish(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Normally not called directly since this page should never show the Finish button.

Specified by:
panelFinish in interface com.filenet.wcm.toolkit.server.base.WcmPanelInterface
Parameters:
request - HttpServletRequest object
response - HttpServletResponse object
Throws:
java.lang.Exception

getValidationErrors

public java.util.Iterator getValidationErrors()
Specified by:
getValidationErrors in interface com.filenet.wcm.toolkit.server.base.WcmPanelValidationInterface

getFormName

public java.lang.String getFormName()
Specified by:
getFormName in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface

findChoice

protected com.filenet.wcm.toolkit.util.WcmString findChoice(java.lang.String value)

isFinished

public boolean isFinished()
                   throws java.lang.Exception
Indicates if the input is complete.

Specified by:
isFinished in interface com.filenet.wcm.toolkit.server.base.WcmSequencePanelInterface
Returns:
boolean indicating if the input is complete.
Throws:
java.lang.Exception


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