com.filenet.wcm.apps.server.ui.wizard.records
Class RMClassificationWizardPage

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.records.RMClassificationWizardPage
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
Direct Known Subclasses:
DeclareRecordsClassificationWizardPage

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

This class displays the record class and classifications selection page for the Record Template Designer wizard.


Nested Class Summary
 class RMClassificationWizardPage.SelectStartingClassificationFolder
          Special class created to override the base class to add other useful methods.
 
Field Summary
protected  com.filenet.wcm.toolkit.server.dp.WcmAuthoringDataProvider adp
           
protected  WcmAuthoringState authState
           
static java.lang.String CLASSIFICATION_LIST_ACCESS
           
protected  com.filenet.wcm.toolkit.server.util.prefs.PrefsLabel classificationLabel
           
protected  com.filenet.wcm.toolkit.server.util.prefs.PrefsLabel classificationsLabel
           
protected  com.filenet.wcm.toolkit.server.util.prefs.PrefsLabel classLabel
           
protected  org.w3c.dom.Document domSelectedClassification
           
protected  WcmEditPage editPage
           
protected static java.lang.String EMAIL_CLASS
           
protected  SelectedClassificationListView listView
           
protected  java.util.Locale locale
           
protected static java.lang.String MARKERS_CLASS
           
static int MASK_EDITABLE
           
static int MASK_HIDE
           
static int MASK_READONLY
           
protected  WcmNavigationState navState
           
static java.lang.String PRIMARY_CLASSIFICATION_ID
           
protected  com.filenet.wcm.toolkit.server.util.prefs.PrefsLabel primaryLabel
           
protected  com.filenet.wcm.toolkit.server.dp.RecordsManageDataProvider rdp
           
static java.lang.String RECORD_CLASS_ACCESS
           
protected static java.lang.String RECORDINFO_CLASS
           
protected  RMClassificationWizardPage.SelectStartingClassificationFolder selectStartingFolder
           
protected  java.lang.String sMode
           
protected  java.lang.String subFolderBrowsing
           
protected  com.filenet.wcm.toolkit.server.util.DeclareRecordsTemplate template
           
protected  WcmUserPrefs userPrefs
           
protected static com.filenet.wcm.toolkit.util.WcmString wsAccess
           
protected static com.filenet.wcm.toolkit.util.WcmString wsAddNew
           
protected static com.filenet.wcm.toolkit.util.WcmString wsChangeValue
           
protected static com.filenet.wcm.toolkit.util.WcmString wsClassifications
           
protected static com.filenet.wcm.toolkit.util.WcmString wsClear
           
protected static com.filenet.wcm.toolkit.util.WcmString wsConstrainMsg
           
protected static com.filenet.wcm.toolkit.util.WcmString wsDefaultValue
           
protected static com.filenet.wcm.toolkit.util.WcmString wsDisplay
           
protected static com.filenet.wcm.toolkit.util.WcmString wsEditable
           
protected static com.filenet.wcm.toolkit.util.WcmString wsHide
           
protected static com.filenet.wcm.toolkit.util.WcmString wsHideMsg
           
protected static com.filenet.wcm.toolkit.util.WcmString wsNone
           
protected static com.filenet.wcm.toolkit.util.WcmString wsNotSelected
           
protected static com.filenet.wcm.toolkit.util.WcmString wsPrimary
           
protected static com.filenet.wcm.toolkit.util.WcmString wsProperty
           
protected static com.filenet.wcm.toolkit.util.WcmString wsReadonly
           
protected static com.filenet.wcm.toolkit.util.WcmString wsRecordClass
           
protected static com.filenet.wcm.toolkit.util.WcmString wsRecordClassLabel
           
protected static com.filenet.wcm.toolkit.util.WcmString wsRemove
           
protected static com.filenet.wcm.toolkit.util.WcmString wsSelectClass
           
protected static com.filenet.wcm.toolkit.util.WcmString wsSelectClassification
           
protected static com.filenet.wcm.toolkit.util.WcmString wsSelectValue
           
protected static com.filenet.wcm.toolkit.util.WcmString wsShowMsg
           
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
NAME_DELIMITER
 
Constructor Summary
RMClassificationWizardPage()
          Constructor calls base class constructor, then creates the required pages.
 
Method Summary
protected  java.lang.String addAdditionalParameters(java.lang.String url)
          Sub class should overide this method if it needs adding additional parameter
protected  java.lang.String configureFPOS(com.filenet.wcm.toolkit.util.WcmURLBuilder url)
          Add all fpos to url
protected  void configureRecordClass(com.filenet.wcm.toolkit.util.WcmURLBuilder url, java.lang.String fpos, int recordType)
          Add class symname and root class id to url
 WcmEditPage getEditPage()
          return edit page object.
 java.lang.String getFormName()
          return form name back.
protected  org.w3c.dom.Document getPropertiesXML(org.w3c.dom.Document propdescs)
          Gets the Document interface on the properties XML
protected  org.w3c.dom.Document getPropertyDescriptionsXML()
          Gets the Document interface on the properties XML.
 SelectedClassificationListView getSelectedClassificationListView()
          return classification list view object
protected  java.lang.String getStartingFolderUrl()
           
 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 onAddNew(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Add classifications event handler.
 void onClassificationListAccess(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          if mode is design then this handler catch classificaiton Display setting of editable, readonly or hide
 void onRecordClass(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Select record class event handler.
 void onRecordClassAccess(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          if mode is design then this handler catch record class display setting of Readonly or Hide
 void onRemove(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          remove event handler
 void onResetValue(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onSelect(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Select event handler.
 void onSelectAsPrimary(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          remove event handler
 void onSetClass(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Set class evnet handler.
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Initialize the Classes
 void onSubFolderBrowsing(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Select event handler, This method use Chain of Responsibility pattern to route form data to related module.
 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 class data.
protected  void renderAccess(java.io.Writer w, java.lang.String fieldName, java.lang.String value, int displayMask)
          Render access field.
protected  void renderButton(java.io.Writer w, java.lang.String eventName, java.lang.String label)
          Render button showing under list view
protected  void renderCommand(java.io.Writer w, boolean requiredOn, java.lang.String linkName, java.lang.String linkLabel, java.lang.String selectedItem)
          Render the command line with required icon, link and selected item
protected  void renderCommand(java.io.Writer w, boolean requiredOn, java.lang.String linkName, com.filenet.wcm.toolkit.util.WcmString linkLabel, java.lang.String selectedItem)
          Render the command line with required icon, link and selected item
protected  void renderSeperator(java.io.Writer w)
          Render a line crossing display area.
protected  void renderTitle(java.io.Writer w, java.lang.String title, java.lang.String fieldName, java.lang.String value, int displayMask)
          Render title and access field if any.
protected  void renderTitle(java.io.Writer w, com.filenet.wcm.toolkit.util.WcmString title, java.lang.String fieldName, java.lang.String value, int displayMask)
          Render title and access field if any.
 void setMode(java.lang.String mode)
          Set moudle mode
 void setStartingFolder(java.lang.String objectStore, java.lang.String folderId)
           
 void setStartingFolderId(java.lang.String folderId)
           
protected  void setupPrimaryClassfication()
           
protected  void setupPrimaryLinkURL()
           
 
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

RECORD_CLASS_ACCESS

public static final java.lang.String RECORD_CLASS_ACCESS
See Also:
Constant Field Values

CLASSIFICATION_LIST_ACCESS

public static final java.lang.String CLASSIFICATION_LIST_ACCESS
See Also:
Constant Field Values

PRIMARY_CLASSIFICATION_ID

public static final java.lang.String PRIMARY_CLASSIFICATION_ID
See Also:
Constant Field Values

wsDisplay

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

wsNone

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

wsRecordClassLabel

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

wsAddNew

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

wsRemove

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

wsClassifications

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

wsPrimary

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

wsSelectClassification

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

wsRecordClass

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

wsSelectClass

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

wsHideMsg

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

wsShowMsg

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

wsProperty

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

wsDefaultValue

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

wsAccess

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

wsEditable

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

wsReadonly

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

wsHide

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

wsConstrainMsg

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

wsNotSelected

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

wsSelectValue

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

wsChangeValue

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

wsClear

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

EMAIL_CLASS

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

RECORDINFO_CLASS

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

MARKERS_CLASS

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

MASK_EDITABLE

public static final int MASK_EDITABLE
See Also:
Constant Field Values

MASK_READONLY

public static final int MASK_READONLY
See Also:
Constant Field Values

MASK_HIDE

public static final int MASK_HIDE
See Also:
Constant Field Values

sMode

protected java.lang.String sMode

domSelectedClassification

protected org.w3c.dom.Document domSelectedClassification

userPrefs

protected WcmUserPrefs userPrefs

adp

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

rdp

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

navState

protected WcmNavigationState navState

authState

protected WcmAuthoringState authState

editPage

protected WcmEditPage editPage

listView

protected SelectedClassificationListView listView

template

protected com.filenet.wcm.toolkit.server.util.DeclareRecordsTemplate template

locale

protected java.util.Locale locale

selectStartingFolder

protected RMClassificationWizardPage.SelectStartingClassificationFolder selectStartingFolder

classificationsLabel

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

classificationLabel

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

primaryLabel

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

classLabel

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

subFolderBrowsing

protected java.lang.String subFolderBrowsing
Constructor Detail

RMClassificationWizardPage

public RMClassificationWizardPage()
                           throws java.lang.Exception
Constructor calls base class constructor, then creates the required pages.

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
Initialize the Classes

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

setupPrimaryClassfication

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

setupPrimaryLinkURL

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

render

public void render(java.io.Writer w)
            throws java.lang.Exception
Renders the class data.

Specified by:
render in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Parameters:
w - Writer for writing to the response object.
Throws:
java.lang.Exception - If there are problems.

renderCommand

protected void renderCommand(java.io.Writer w,
                             boolean requiredOn,
                             java.lang.String linkName,
                             com.filenet.wcm.toolkit.util.WcmString linkLabel,
                             java.lang.String selectedItem)
                      throws java.lang.Exception
Render the command line with required icon, link and selected item

Parameters:
w - Writer
requiredOn - Display required icon
linkName - Link event name without "on"
linkLabel - Link label
selectedItem - Selected item
Throws:
java.lang.Exception

renderCommand

protected void renderCommand(java.io.Writer w,
                             boolean requiredOn,
                             java.lang.String linkName,
                             java.lang.String linkLabel,
                             java.lang.String selectedItem)
                      throws java.lang.Exception
Render the command line with required icon, link and selected item

Parameters:
w - Writer
requiredOn - Display required icon
linkName - Link event name without "on"
linkLabel - Link label
selectedItem - Selected item
Throws:
java.lang.Exception

renderSeperator

protected void renderSeperator(java.io.Writer w)
                        throws java.lang.Exception
Render a line crossing display area.

Parameters:
w - Writer
Throws:
java.lang.Exception

renderTitle

protected void renderTitle(java.io.Writer w,
                           com.filenet.wcm.toolkit.util.WcmString title,
                           java.lang.String fieldName,
                           java.lang.String value,
                           int displayMask)
                    throws java.lang.Exception
Render title and access field if any. If no field name is null, no access field will be displayed.

Parameters:
w - Writer
title - Title
fieldName - Access field name
value - Current selected value. This value is used to turn on selected key word.
displayMask - Display options
Throws:
java.lang.Exception

renderTitle

protected void renderTitle(java.io.Writer w,
                           java.lang.String title,
                           java.lang.String fieldName,
                           java.lang.String value,
                           int displayMask)
                    throws java.lang.Exception
Render title and access field if any. If no field name is null, no access field will be displayed.

Parameters:
w - Writer
title - Title
fieldName - Access field name
value - Current selected value. This value is used to turn on selected key word.
displayMask - Display options
Throws:
java.lang.Exception

renderAccess

protected void renderAccess(java.io.Writer w,
                            java.lang.String fieldName,
                            java.lang.String value,
                            int displayMask)
                     throws java.lang.Exception
Render access field. Despends on displayMask this field can have up to three different options; Editable, Readonly, or Hide

Parameters:
w - Writer
fieldName - Access field name
value - Current selected value. This value is used to turn on selected key word.
displayMask - Display options
Throws:
java.lang.Exception

renderButton

protected void renderButton(java.io.Writer w,
                            java.lang.String eventName,
                            java.lang.String label)
                     throws java.lang.Exception
Render button showing under list view

Parameters:
w - Writer
eventName - Event name
label - Label
Throws:
java.lang.Exception

onSubFolderBrowsing

public void onSubFolderBrowsing(javax.servlet.http.HttpServletRequest request,
                                javax.servlet.http.HttpServletResponse response)
                         throws java.lang.Exception
Select event handler, This method use Chain of Responsibility pattern to route form data to related module.

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

onRecordClass

public void onRecordClass(javax.servlet.http.HttpServletRequest request,
                          javax.servlet.http.HttpServletResponse response)
                   throws java.lang.Exception
Select record class event handler. Selected class will be updated by onSetClass event handler. form data to related module.

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

configureRecordClass

protected void configureRecordClass(com.filenet.wcm.toolkit.util.WcmURLBuilder url,
                                    java.lang.String fpos,
                                    int recordType)
                             throws java.lang.Exception
Add class symname and root class id to url

Parameters:
url -
fpos -
recordType -
Throws:
java.lang.Exception

configureFPOS

protected java.lang.String configureFPOS(com.filenet.wcm.toolkit.util.WcmURLBuilder url)
                                  throws java.lang.Exception
Add all fpos to url

Parameters:
url -
Returns:
File plan object store name
Throws:
java.lang.Exception

onSetClass

public void onSetClass(javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response)
                throws java.lang.Exception
Set class evnet handler. This method update record template properties and property description object depends on what record class is selected.

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

onResetValue

public void onResetValue(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response)
                  throws java.lang.Exception
Throws:
java.lang.Exception

onAddNew

public void onAddNew(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
Add classifications event handler. This module foward object store name to classification page therefore missing this information cause exception to be thrown.

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

addAdditionalParameters

protected java.lang.String addAdditionalParameters(java.lang.String url)
                                            throws java.lang.Exception
Sub class should overide this method if it needs adding additional parameter

Parameters:
url - URL
Returns:
URL in string format
Throws:
java.lang.Exception

onRecordClassAccess

public void onRecordClassAccess(javax.servlet.http.HttpServletRequest request,
                                javax.servlet.http.HttpServletResponse response)
                         throws java.lang.Exception
if mode is design then this handler catch record class display setting of Readonly or Hide

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

onClassificationListAccess

public void onClassificationListAccess(javax.servlet.http.HttpServletRequest request,
                                       javax.servlet.http.HttpServletResponse response)
                                throws java.lang.Exception
if mode is design then this handler catch classificaiton Display setting of editable, readonly or hide

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

onSelect

public void onSelect(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
Select event handler. Foward selection to edit page.

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

onRemove

public void onRemove(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
remove event handler

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

onSelectAsPrimary

public void onSelectAsPrimary(javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.HttpServletResponse response)
                       throws java.lang.Exception
remove event handler

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

getPropertiesXML

protected org.w3c.dom.Document getPropertiesXML(org.w3c.dom.Document propdescs)
                                         throws java.lang.Exception
Gets the Document interface on the properties XML

Returns:
The output xml.
Throws:
java.lang.Exception

getPropertyDescriptionsXML

protected org.w3c.dom.Document getPropertyDescriptionsXML()
                                                   throws java.lang.Exception
Gets the Document interface on the properties XML. Also sets the class property for the output XML.

Returns:
The property descriptions xml.
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

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. It calls wizardFinish to set the Authoring state using the chosen folder.

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

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. The wizardSave method forwards save requests here where it sets the Authoring state using the chosen folder.

Specified by:
panelFinish 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
Throws:
java.lang.Exception

setStartingFolderId

public void setStartingFolderId(java.lang.String folderId)

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

getValidationErrors

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

isFinished

public boolean isFinished()
                   throws java.lang.Exception
Indicates if the input is complete. If a folder is selected, returns true. If an object store is selected and a folder is being added, returns true. Returns false otherwise.

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

setMode

public void setMode(java.lang.String mode)
Set moudle mode

Parameters:
mode - - Modify or Add

getFormName

public java.lang.String getFormName()
return form name back.

Specified by:
getFormName in interface com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface

getEditPage

public WcmEditPage getEditPage()
return edit page object.


getSelectedClassificationListView

public SelectedClassificationListView getSelectedClassificationListView()
return classification list view object


getStartingFolderUrl

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

setStartingFolder

public void setStartingFolder(java.lang.String objectStore,
                              java.lang.String folderId)


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