com.filenet.wcm.apps.server.ui.info
Class PropertiesFilterInfoPage

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.WcmXSLModule
                      extended bycom.filenet.wcm.apps.server.ui.info.PropertiesFilterInfoPage
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.WcmUiModuleInterface, com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface

public class PropertiesFilterInfoPage
extends com.filenet.wcm.toolkit.server.ui.WcmXSLModule
implements com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface, com.filenet.wcm.toolkit.server.base.WcmPanelValidationInterface


Field Summary
protected  com.filenet.wcm.toolkit.server.dp.WcmAuthoringDataProvider adp
           
protected  WcmAuthoringState aState
           
protected  com.filenet.wcm.toolkit.server.base.WcmController controller
           
static int CUSTOM_OBJECT_TYPE
           
protected  boolean defaultMode
           
static int DOCUMENT_TYPE
           
static int FOLDER_TYPE
           
protected  java.lang.String formName
           
protected  java.lang.String mode
           
protected static java.lang.String NAME
           
protected  com.filenet.wcm.toolkit.server.dp.WcmNavigationDataProvider ndp
           
protected static int NORMAL
           
protected  WcmNavigationState nState
           
protected  int nType
           
protected  java.lang.String objectStoreName
           
protected static java.lang.String PROPERTIES_FILTERED_KEY
           
protected  PropertiesFilterUtil propertiesUtil
           
protected static java.lang.String PROPERTY_DESCRIPTIONS_KEY
           
protected  com.filenet.wcm.toolkit.server.dp.RecordsManageDataProvider rdp
           
protected static int READONLY
           
static int RM_RECORD_TYPE
           
 
Fields inherited from class com.filenet.wcm.toolkit.server.ui.WcmXSLModule
transformUtil
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
PropertiesFilterInfoPage()
           
PropertiesFilterInfoPage(int type)
          Constructor sets the Property type to one of the static int values defined above.
 
Method Summary
protected  org.w3c.dom.Document getFilteredPropertiesXML()
          Gets the Document interface on the properties XML.
 java.lang.String getFormName()
           
protected  org.w3c.dom.Document getPropDescsXML(int type)
          Gets the Document interface on the properties XML.
 java.util.Iterator getValidationErrors()
          Unused.
 void initialize()
           
 boolean isApplyButtonRequired()
          Tells the Info page if it should put up an Apply button.
 boolean isModified()
          Indicates that the state has changed as a result of a wizardSave call.
 void onChangePage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Used by links to redirect to secondary property pages after it submits the form by calling onSubmit.
 void onOrganizePropertyDescritions(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Set the promote as Major version setting
 void onSubmit(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          This event updates the output XML from the request data.
protected  void organizePropertyDescritions(org.w3c.dom.Document domPropDescs, java.lang.String[] organizedPropDescs, java.lang.String[] redefineProps)
           
protected  void organizePropertyDescritions(java.lang.String[] organziedList)
           
 boolean pageValidate()
          Called on a page to check any entered data to confirm that everything is valid.
 void panelFinish(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          This event updates the output XML from the request data.
 void panelSave(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          This event updates the output XML from the request data.
 boolean panelValidate()
          Called on a page to check any entered data to confirm that everything is valid.
 void setFilteredPropertiesXML(org.w3c.dom.Document xml)
           
 void setFormName(java.lang.String formName)
           
 void setPrefObjectStoreName(java.lang.String prefObjectStoreName)
           
 
Methods inherited from class com.filenet.wcm.toolkit.server.ui.WcmXSLModule
convertToNodeList, getXML, getXSLParameter, render, renderXSL, setXML, setXML, setXML, setXML, setXSL, setXSLParameter, setXSLParameter, setXSLParameter, setXSLParameter, setXSLParameter, setXSLParameter
 
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

RM_RECORD_TYPE

public static final int RM_RECORD_TYPE
See Also:
Constant Field Values

DOCUMENT_TYPE

public static final int DOCUMENT_TYPE
See Also:
Constant Field Values

FOLDER_TYPE

public static final int FOLDER_TYPE
See Also:
Constant Field Values

CUSTOM_OBJECT_TYPE

public static final int CUSTOM_OBJECT_TYPE
See Also:
Constant Field Values

NAME

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

PROPERTIES_FILTERED_KEY

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

PROPERTY_DESCRIPTIONS_KEY

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

READONLY

protected static final int READONLY
See Also:
Constant Field Values

NORMAL

protected static final int NORMAL
See Also:
Constant Field Values

nType

protected int nType

mode

protected java.lang.String mode

defaultMode

protected boolean defaultMode

controller

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

adp

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

rdp

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

ndp

protected com.filenet.wcm.toolkit.server.dp.WcmNavigationDataProvider ndp

aState

protected WcmAuthoringState aState

nState

protected WcmNavigationState nState

propertiesUtil

protected PropertiesFilterUtil propertiesUtil

objectStoreName

protected java.lang.String objectStoreName

formName

protected java.lang.String formName
Constructor Detail

PropertiesFilterInfoPage

public PropertiesFilterInfoPage()
                         throws java.lang.Exception

PropertiesFilterInfoPage

public PropertiesFilterInfoPage(int type)
                         throws java.lang.Exception
Constructor sets the Property type to one of the static int values defined above.

Parameters:
type - One of the defined int field types.
Method Detail

initialize

public void initialize()
                throws java.lang.Exception
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
Set the promote as Major version setting

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

onChangePage

public void onChangePage(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response)
                  throws java.lang.Exception
Used by links to redirect to secondary property pages after it submits the form by calling onSubmit.

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

onOrganizePropertyDescritions

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

organizePropertyDescritions

protected void organizePropertyDescritions(java.lang.String[] organziedList)
                                    throws java.lang.Exception
Throws:
java.lang.Exception

organizePropertyDescritions

protected void organizePropertyDescritions(org.w3c.dom.Document domPropDescs,
                                           java.lang.String[] organizedPropDescs,
                                           java.lang.String[] redefineProps)
                                    throws java.lang.Exception
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

getPropDescsXML

protected org.w3c.dom.Document getPropDescsXML(int type)
                                        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

getFilteredPropertiesXML

protected org.w3c.dom.Document getFilteredPropertiesXML()
                                                 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

setFilteredPropertiesXML

public void setFilteredPropertiesXML(org.w3c.dom.Document xml)
                              throws java.lang.Exception
Throws:
java.lang.Exception

setPrefObjectStoreName

public void setPrefObjectStoreName(java.lang.String prefObjectStoreName)
                            throws java.lang.Exception
Throws:
java.lang.Exception

panelSave

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

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
This event updates the output XML from the request data.

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

pageValidate

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

Throws:
java.lang.Exception

isModified

public boolean isModified()
                   throws java.lang.Exception
Indicates that the state has changed as a result of a wizardSave call.

Specified by:
isModified in interface com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface
Returns:
true if page's state has changed.
Throws:
java.lang.Exception

isApplyButtonRequired

public boolean isApplyButtonRequired()
                              throws java.lang.Exception
Tells the Info page if it should put up an Apply button.

Specified by:
isApplyButtonRequired in interface com.filenet.wcm.toolkit.server.base.WcmViewPanelInterface
Returns:
true.
Throws:
java.lang.Exception

getValidationErrors

public java.util.Iterator getValidationErrors()
Unused.

Specified by:
getValidationErrors in interface com.filenet.wcm.toolkit.server.base.WcmPanelValidationInterface
Returns:
null

setFormName

public void setFormName(java.lang.String formName)

getFormName

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


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