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

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.WcmPropertiesWizardPage
                      extended bycom.filenet.wcm.apps.server.ui.wizard.WcmEntryPropertiesWizardPage
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 WcmEntryPropertiesWizardPage
extends WcmPropertiesWizardPage


Field Summary
protected  com.filenet.wcm.toolkit.server.dp.WcmAuthoringDataProvider authoringDataProvider
           
protected  WcmAuthoringState authorState
           
protected  com.filenet.wcm.toolkit.server.util.WcmEntryTemplate entryTemplate
           
protected  int nType
           
protected  WcmDesignerPropertiesUtil propertiesUtil
           
protected  WcmPropertiesUtil propsUtil
           
protected  com.filenet.wcm.toolkit.server.dp.RecordsManageDataProvider recordsManageDataProvider
           
 
Fields inherited from class com.filenet.wcm.apps.server.ui.wizard.WcmPropertiesWizardPage
className
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
WcmEntryPropertiesWizardPage(int mode)
           
 
Method Summary
protected  org.w3c.dom.Document getDocumentTitlePattern(org.w3c.dom.Document destXMLProperties)
           
 java.lang.String getRootClassId(javax.servlet.http.HttpServletRequest request)
          Gets the Document interface on the Object Class XML
protected  org.w3c.dom.Document getUniquePropDescs(org.w3c.dom.Document srcXMLPropDescs, org.w3c.dom.Document destXMLPropDescs)
          Remove found property description from record manage property description.
 java.util.Iterator getValidationErrors()
           
 void initialize()
          Initializes the Module for use in the Entry wizard.
 java.lang.String onGetKey(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Switch to different state key if property is in record properties xml.
 java.lang.String onGetLocation(java.lang.String objectStoreName)
           
 org.w3c.dom.Document onGetProperties(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Switch to different properties if property is in record properties xml.
 org.w3c.dom.Document onGetPropertyDescs(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Don't call this method directly.
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Initialize the child modules
 void onSubmit(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          This event updates the output XML from the request data.
 void panelInit()
          Called when this wizard page is first loaded to initialize any class or property information.
 void panelSave(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Sends wizardSave to the WcmPropertiesInfoPage.
 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 document classes and properties.
 org.w3c.dom.Document updateRecordProperties(org.w3c.dom.Document srcXMLProperties, org.w3c.dom.Document destXMLProperties)
          Copy document properties to record properties if it has same synmane
 
Methods inherited from class com.filenet.wcm.apps.server.ui.wizard.WcmPropertiesWizardPage
getFormName, getPropertiesInfoPage, isFinished, panelCancel, panelFinish
 
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

authoringDataProvider

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

recordsManageDataProvider

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

authorState

protected WcmAuthoringState authorState

entryTemplate

protected com.filenet.wcm.toolkit.server.util.WcmEntryTemplate entryTemplate

propertiesUtil

protected WcmDesignerPropertiesUtil propertiesUtil

propsUtil

protected WcmPropertiesUtil propsUtil

nType

protected int nType
Constructor Detail

WcmEntryPropertiesWizardPage

public WcmEntryPropertiesWizardPage(int mode)
                             throws java.lang.Exception
Method Detail

initialize

public void initialize()
                throws java.lang.Exception
Initializes the Module for use in the Entry wizard.

Specified by:
initialize in interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface
Overrides:
initialize in class WcmPropertiesWizardPage
Throws:
java.lang.Exception - All errors.

onStartPage

public void onStartPage(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                 throws java.lang.Exception
Initialize the child modules

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

getRootClassId

public java.lang.String getRootClassId(javax.servlet.http.HttpServletRequest request)
                                throws java.lang.Exception
Description copied from class: WcmPropertiesWizardPage
Gets the Document interface on the Object Class XML

Overrides:
getRootClassId in class WcmPropertiesWizardPage
Returns:
the Object Store Classes XML
Throws:
java.lang.Exception

getUniquePropDescs

protected org.w3c.dom.Document getUniquePropDescs(org.w3c.dom.Document srcXMLPropDescs,
                                                  org.w3c.dom.Document destXMLPropDescs)
                                           throws java.lang.Exception
Remove found property description from record manage property description. This allow us to display only none duplicated property in this page where document property is on uppper section and lower section occupy by record manage proeprties. Display same property in each section will consider redudent. Any required proeprty in record manage section with same property name in document section need to mark those to be requried too.

Parameters:
srcXMLPropDescs - The document property descriptions
destXMLPropDescs - The record manage property descriptions
Returns:
WcmXMLPropDescs The new object
Throws:
java.lang.Exception

updateRecordProperties

public org.w3c.dom.Document updateRecordProperties(org.w3c.dom.Document srcXMLProperties,
                                                   org.w3c.dom.Document destXMLProperties)
                                            throws java.lang.Exception
Copy document properties to record properties if it has same synmane

Parameters:
srcXMLProperties - Document properties
destXMLProperties - Record properties
Returns:
Copied record properties
Throws:
java.lang.Exception

getDocumentTitlePattern

protected org.w3c.dom.Document getDocumentTitlePattern(org.w3c.dom.Document destXMLProperties)
                                                throws java.lang.Exception
Throws:
java.lang.Exception

onGetProperties

public org.w3c.dom.Document onGetProperties(javax.servlet.http.HttpServletRequest request,
                                            javax.servlet.http.HttpServletResponse response)
                                     throws java.lang.Exception
Switch to different properties if property is in record properties xml. Don't call this method directly. This method should be called by inner object.

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

onGetKey

public java.lang.String onGetKey(javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response)
                          throws java.lang.Exception
Switch to different state key if property is in record properties xml. Don't call this method directly. This method should be called by inner object.

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

onGetPropertyDescs

public org.w3c.dom.Document onGetPropertyDescs(javax.servlet.http.HttpServletRequest request,
                                               javax.servlet.http.HttpServletResponse response)
                                        throws java.lang.Exception
Don't call this method directly. This method should be called by inner object and it is for RM only

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

onGetLocation

public java.lang.String onGetLocation(java.lang.String objectStoreName)
                               throws java.lang.Exception
Throws:
java.lang.Exception

render

public void render(java.io.Writer w)
            throws java.lang.Exception
Renders the document classes and properties.

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

onSubmit

public void onSubmit(javax.servlet.http.HttpServletRequest request,
                     javax.servlet.http.HttpServletResponse response)
              throws java.lang.Exception
This event updates the output XML from the request data.

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

panelInit

public void panelInit()
               throws java.lang.Exception
Called when this wizard page is first loaded to initialize any class or property information.

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

panelSave

public void panelSave(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
               throws java.lang.Exception
Sends wizardSave to the WcmPropertiesInfoPage.

Specified by:
panelSave in interface com.filenet.wcm.toolkit.server.base.WcmPanelInterface
Overrides:
panelSave in class WcmPropertiesWizardPage
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
Overrides:
panelValidate in class WcmPropertiesWizardPage
Throws:
java.lang.Exception

getValidationErrors

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


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