com.filenet.wcm.apps.server.util

Class WcmSearchState

  1. java.lang.Object
  2. extended bycom.filenet.wcm.apps.server.util.WcmSearchState
All implemented interfaces:
java.lang.Cloneable
  1. public class WcmSearchState
  2. extends java.lang.Object
  3. implements java.lang.Cloneable
Utility class used by UI modules in the Search page. Keeps the state of the page, and caches some data, thereby reducing the hits to WcmSearchDataProvider.

Field Summary

Modifier and Type Field and Description
  1. org.w3c.dom.Document
 choiceList
  1. boolean
 classUpdated
  1. boolean
 collapsed
  1. org.w3c.dom.Document
 definition
  1. org.w3c.dom.Document
 fullDefinition
  1. int
 majorVersion
  1. int
 minorVersion
  1. java.lang.String
 objectStoreName
  1. java.lang.String[]
 propAlignments
  1. java.lang.String[]
 propNames
  1. org.w3c.dom.Document
 request
  1. java.lang.String
 results
  1. java.lang.String
 searchID
  1. java.lang.String
 searchLabel
  1. java.lang.String
 searchVSID
  1. boolean
 showRanking
  1. boolean
 showSummary
  1. boolean
 showTime
  1. boolean
 sortOrder
  1. java.lang.String
 sortProperty
  1. boolean
 updateResults
  1. int
 versionStatus

Constructor Summary

Constructor and Description
WcmSearchState()

Method Summary

Modifier and Type Method and Description
  1. void
 clear()
Clears the current state
  1. void
 clearSearchData()
Clears selected search data
  1. java.lang.Object
 clone()
Clone a state object.
  1. static
  2. WcmSearchState
 getInstance(com.filenet.wcm.toolkit.server.dp.WcmSearchDataProvider dp)
Factory method that returns a new instance of the WcmSearchState, scoped to the data provider.
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

objectStoreName

  1. public java.lang.String objectStoreName

searchID

  1. public java.lang.String searchID

searchVSID

  1. public java.lang.String searchVSID

searchLabel

  1. public java.lang.String searchLabel

request

  1. public org.w3c.dom.Document request

definition

  1. public org.w3c.dom.Document definition

fullDefinition

  1. public org.w3c.dom.Document fullDefinition

choiceList

  1. public org.w3c.dom.Document choiceList

results

  1. public java.lang.String results

updateResults

  1. public boolean updateResults

collapsed

  1. public boolean collapsed

showRanking

  1. public boolean showRanking

showSummary

  1. public boolean showSummary

showTime

  1. public boolean showTime

propNames

  1. public java.lang.String[] propNames

propAlignments

  1. public java.lang.String[] propAlignments

majorVersion

  1. public int majorVersion

minorVersion

  1. public int minorVersion

versionStatus

  1. public int versionStatus

sortProperty

  1. public java.lang.String sortProperty

sortOrder

  1. public boolean sortOrder

classUpdated

  1. public boolean classUpdated

Constructor Detail

WcmSearchState

  1. public WcmSearchState()

Method Detail

clear

  1. public void clear()
Clears the current state

clearSearchData

  1. public void clearSearchData()
Clears selected search data

clone

  1. public java.lang.Object clone()
  2. throws java.lang.CloneNotSupportedException
Clone a state object.
Overrides:
clone in class java.lang.Object
Returns:
Object A cloned object
Throws:
java.lang.CloneNotSupportedException - if super don't support it.

getInstance

  1. public static WcmSearchState getInstance( com.filenet.wcm.toolkit.server.dp.WcmSearchDataProvider dp)
  2. throws java.lang.Exception
Factory method that returns a new instance of the WcmSearchState, scoped to the data provider. It is stored as a module property of that data provider. This is the only way that a reference to this object can be obtained.
Parameters:
dp - WcmSearchDataProvider module
Returns:
New instance of WcmSearchState object, scoped to the data provider
Throws:
java.lang.Exception - If any errors occured