com.filenet.wcm.apps.server.ui
Class SimpleSearchModule

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.SimpleSearchRenderingModule
                      extended bycom.filenet.wcm.apps.server.ui.SimpleSearchModule
All Implemented Interfaces:
com.filenet.wcm.toolkit.server.base.WcmModuleInterface, com.filenet.wcm.toolkit.server.base.WcmUiModuleInterface
Direct Known Subclasses:
BrowseListView.FolderNavSimpleSearch, SelectOperation.SelectionSimpleSearch

public class SimpleSearchModule
extends SimpleSearchRenderingModule

Simple Search page.


Field Summary
protected  boolean alwaysMagazine
           
static int DOCUMENT
           
protected static java.lang.String FILTER_TYPE_KEY
           
protected  boolean filterPage
           
protected  java.lang.String foldersearchstring
           
protected  SimpleSearchResultsListView listView
           
protected static java.lang.String PRINT_STATE_KEY
           
static java.lang.String STATE_KEY
           
protected  WcmTextLinksBar textLinksBar
           
protected static java.lang.String TYPE_STRING
           
protected static com.filenet.wcm.toolkit.util.WcmString wsClearCriteriaText
           
 
Fields inherited from class com.filenet.wcm.apps.server.ui.SimpleSearchRenderingModule
adp, ALL_VERSIONS, classLabel, config, controller, CURRENT_VERSION, dateFormat, ds, ENDS_WITH, EQ, FORM_NAME, GT, GTEQ, HIDE, IN, ISNOTNULL, ISNULL, LIKE, LT, LTEQ, NEQ, OBJTYPE_CUSTOM_OBJECT, OBJTYPE_DOCUMENT, OBJTYPE_FOLDER, RELEASED_VERSION, SHOW, sitePrefs, STARTS_WITH, state, subclassesLabel, timeFormat, timezone, wsCustomObject, wsDocument, wsFilterByClass, wsFolder, wsIncludeSubclasses
 
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule
locale, NAME_DELIMITER
 
Constructor Summary
SimpleSearchModule()
           
 
Method Summary
protected  void addAdditionalDocumentProps(com.filenet.wcm.toolkit.server.util.FilterData filterData)
          Overrides by sub classes to add addtional criteria to the search criteria.
protected  void addBrowseDocFilter(com.filenet.wcm.toolkit.server.util.FilterData filter)
           
protected  void addSetAsDefaultLink()
           
protected  void addSwitchModeLink()
           
protected  void clearStateCriteria()
           
protected  void configureListView()
           
protected  void createListView()
           
protected  void doSearch()
           
 java.lang.String getFormName()
           
 java.lang.String getSearchObjectStore()
           
protected  boolean getShowSearchFor()
           
 SimpleSearchResultsListView getSimpleSearchResultsListView()
           
protected  void getTemplatePropItems(javax.servlet.http.HttpServletRequest request)
           
 void initialize()
           
 SimpleSearchState loadState(java.lang.String objectType, java.lang.String objectStoreName)
           
 void onChangeObjectType(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onClearChoice(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onClearClass(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onClearCriteria(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Clears the form to empty values.
 void onClearUser(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onExecuteSearch(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Event that occurs when user clicks on "Execute" button
 void onGetNewCriteria(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          To change user preferences for simple search
 void onHideSearch(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onPrintView(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onReset(com.filenet.wcm.toolkit.server.util.event.GlobalEvent evt)
           
 void onSelectIncludeSubclasses(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onSelectObject(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Handle Select Object event.
 void onSelectUser(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          Pops up Select User dialog
 void onSetAsDefault(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onSetChoice(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onSetClass(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onSetObject(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onSetSearchIn(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onSetUser(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onShowSearch(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onStartPage(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
 void onStateChanged(com.filenet.wcm.toolkit.server.util.event.GlobalEvent e)
           
 void onStateChanged(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
           
protected  void readPropData(javax.servlet.http.HttpServletRequest request)
           
 void render(java.io.Writer w)
           
protected  boolean renderFilterClass(java.io.Writer w)
           
protected  void renderFilterClassUI(java.io.Writer w, boolean readOnlyMode)
           
protected  void renderOperator(java.lang.String multiValue, java.lang.String oper, int i, java.lang.String symName, java.io.Writer w)
           
protected  void renderSingleProperty(java.lang.String propType, java.io.Writer w, java.lang.String multiValue, java.lang.String oper, java.lang.String symName, java.lang.String propertyValue, int i, java.util.List markingList, java.util.List choiceList, java.lang.String hcvlId, int len)
           
 void setHideFilterClass(boolean value)
          Sets the show filter class flag
 void setSearchContainerTypes(java.lang.String[] newContainerTypes)
          Sets contenttypes for Folder search
 void setSearchCustomObjectTypes(java.lang.String[] newCustomObjectTypes)
          Sets CustomObjectTypes for Custom Object search
 void setSearchingObjectStore(java.lang.String objStore, java.lang.String folderPath, java.lang.String folderName)
           
 void setSearchingObjectType(int objectType, java.lang.String filterClass, java.lang.String objStore, java.lang.String folderPath, java.lang.String folderName)
           
 void setSearchMimeTypes(java.lang.String[] newMimeTypes)
          Sets mimetypes for Document search
 
Methods inherited from class com.filenet.wcm.apps.server.ui.SimpleSearchRenderingModule
getCVLlistboxIndex, getCVLlistboxValue, getOperatorLabel, renderAndOrValue, renderCheckboxes, renderContentCriteria, renderFilterClassReadOnly, renderFilterProperty, renderLabelAndOperator, renderObjectTypeDropDown, renderPathAndToolBar, renderPropertyCriteria, renderSeparator, renderVersionOptionDropDown
 
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

wsClearCriteriaText

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

STATE_KEY

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

DOCUMENT

public static final int DOCUMENT
See Also:
Constant Field Values

FILTER_TYPE_KEY

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

PRINT_STATE_KEY

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

TYPE_STRING

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

textLinksBar

protected WcmTextLinksBar textLinksBar

listView

protected SimpleSearchResultsListView listView

alwaysMagazine

protected boolean alwaysMagazine

foldersearchstring

protected java.lang.String foldersearchstring

filterPage

protected boolean filterPage
Constructor Detail

SimpleSearchModule

public SimpleSearchModule()
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 SimpleSearchRenderingModule
Throws:
java.lang.Exception

onReset

public void onReset(com.filenet.wcm.toolkit.server.util.event.GlobalEvent evt)
             throws java.lang.Exception
Throws:
java.lang.Exception

onStateChanged

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

onSetClass

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

onSelectIncludeSubclasses

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

onSetSearchIn

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

onStateChanged

public void onStateChanged(com.filenet.wcm.toolkit.server.util.event.GlobalEvent e)
                    throws java.lang.Exception
Throws:
java.lang.Exception

setSearchMimeTypes

public void setSearchMimeTypes(java.lang.String[] newMimeTypes)
Sets mimetypes for Document search

Parameters:
newMimeTypes - sets value

setSearchCustomObjectTypes

public void setSearchCustomObjectTypes(java.lang.String[] newCustomObjectTypes)
Sets CustomObjectTypes for Custom Object search

Parameters:
newCustomObjectTypes - sets value

setSearchContainerTypes

public void setSearchContainerTypes(java.lang.String[] newContainerTypes)
Sets contenttypes for Folder search

Parameters:
newContainerTypes - sets value

setSearchingObjectStore

public void setSearchingObjectStore(java.lang.String objStore,
                                    java.lang.String folderPath,
                                    java.lang.String folderName)
                             throws java.lang.Exception
Throws:
java.lang.Exception

setSearchingObjectType

public void setSearchingObjectType(int objectType,
                                   java.lang.String filterClass,
                                   java.lang.String objStore,
                                   java.lang.String folderPath,
                                   java.lang.String folderName)
                            throws java.lang.Exception
Throws:
java.lang.Exception

createListView

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

configureListView

protected void configureListView()
                          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
Throws:
java.lang.Exception

onPrintView

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

render

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

getShowSearchFor

protected boolean getShowSearchFor()

renderSingleProperty

protected void renderSingleProperty(java.lang.String propType,
                                    java.io.Writer w,
                                    java.lang.String multiValue,
                                    java.lang.String oper,
                                    java.lang.String symName,
                                    java.lang.String propertyValue,
                                    int i,
                                    java.util.List markingList,
                                    java.util.List choiceList,
                                    java.lang.String hcvlId,
                                    int len)
                             throws java.lang.Exception
Overrides:
renderSingleProperty in class SimpleSearchRenderingModule
Throws:
java.lang.Exception

renderFilterClass

protected boolean renderFilterClass(java.io.Writer w)
                             throws java.lang.Exception
Throws:
java.lang.Exception

renderFilterClassUI

protected void renderFilterClassUI(java.io.Writer w,
                                   boolean readOnlyMode)
                            throws java.lang.Exception
Throws:
java.lang.Exception

renderOperator

protected void renderOperator(java.lang.String multiValue,
                              java.lang.String oper,
                              int i,
                              java.lang.String symName,
                              java.io.Writer w)
                       throws java.lang.Exception
Overrides:
renderOperator in class SimpleSearchRenderingModule
Throws:
java.lang.Exception

onClearChoice

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

onSetChoice

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

onSetUser

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

getTemplatePropItems

protected void getTemplatePropItems(javax.servlet.http.HttpServletRequest request)
                             throws java.lang.Exception
Throws:
java.lang.Exception

readPropData

protected void readPropData(javax.servlet.http.HttpServletRequest request)
                     throws java.lang.Exception
Throws:
java.lang.Exception

onChangeObjectType

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

onSelectObject

public void onSelectObject(javax.servlet.http.HttpServletRequest request,
                           javax.servlet.http.HttpServletResponse response)
                    throws java.lang.Exception
Handle Select Object event. Redirects to the Select Object operation page for selecting a value for an object valued property.

Parameters:
request - The request Object
response - The response Object
Throws:
java.lang.Exception

onSetObject

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

onExecuteSearch

public void onExecuteSearch(javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response)
                     throws java.lang.Exception
Event that occurs when user clicks on "Execute" button

Throws:
java.lang.Exception

addBrowseDocFilter

protected void addBrowseDocFilter(com.filenet.wcm.toolkit.server.util.FilterData filter)
                           throws java.lang.Exception
Throws:
java.lang.Exception

doSearch

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

getFormName

public java.lang.String getFormName()

loadState

public SimpleSearchState loadState(java.lang.String objectType,
                                   java.lang.String objectStoreName)
                            throws java.lang.Exception
Throws:
java.lang.Exception

onClearCriteria

public void onClearCriteria(javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response)
                     throws java.lang.Exception
Clears the form to empty values.

Throws:
java.lang.Exception

clearStateCriteria

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

onSelectUser

public void onSelectUser(javax.servlet.http.HttpServletRequest request,
                         javax.servlet.http.HttpServletResponse response)
                  throws java.lang.Exception
Pops up Select User dialog

Throws:
java.lang.Exception

onClearUser

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

setHideFilterClass

public void setHideFilterClass(boolean value)
Sets the show filter class flag


onClearClass

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

onShowSearch

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

onHideSearch

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

onGetNewCriteria

public void onGetNewCriteria(javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response)
                      throws java.lang.Exception
To change user preferences for simple search

Throws:
java.lang.Exception

addSetAsDefaultLink

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

addSwitchModeLink

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

onSetAsDefault

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

getSimpleSearchResultsListView

public SimpleSearchResultsListView getSimpleSearchResultsListView()

getSearchObjectStore

public java.lang.String getSearchObjectStore()

addAdditionalDocumentProps

protected void addAdditionalDocumentProps(com.filenet.wcm.toolkit.server.util.FilterData filterData)
                                   throws java.lang.Exception
Overrides by sub classes to add addtional criteria to the search criteria.

Throws:
java.lang.Exception


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