com.filenet.wcm.apps.server.util
Class WcmSearchState

java.lang.Object
  extended bycom.filenet.wcm.apps.server.util.WcmSearchState
All Implemented Interfaces:
java.lang.Cloneable

public class WcmSearchState
extends java.lang.Object
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
 org.w3c.dom.Document choiceList
           
 boolean classUpdated
           
 boolean collapsed
           
 org.w3c.dom.Document definition
           
 org.w3c.dom.Document fullDefinition
           
 int majorVersion
           
 int minorVersion
           
 java.lang.String objectStoreName
           
 java.lang.String[] propAlignments
           
 java.lang.String[] propNames
           
 org.w3c.dom.Document request
           
 java.lang.String results
           
 java.lang.String searchID
           
 java.lang.String searchLabel
           
 java.lang.String searchVSID
           
 boolean showRanking
           
 boolean showSummary
           
 boolean showTime
           
 boolean sortOrder
           
 java.lang.String sortProperty
           
 boolean updateResults
           
 int versionStatus
           
 
Constructor Summary
WcmSearchState()
           
 
Method Summary
 void clear()
          Clears the current state
 void clearSearchData()
          Clears selected search data
 java.lang.Object clone()
          Clone a state object.
static 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

public java.lang.String objectStoreName

searchID

public java.lang.String searchID

searchVSID

public java.lang.String searchVSID

searchLabel

public java.lang.String searchLabel

request

public org.w3c.dom.Document request

definition

public org.w3c.dom.Document definition

fullDefinition

public org.w3c.dom.Document fullDefinition

choiceList

public org.w3c.dom.Document choiceList

results

public java.lang.String results

updateResults

public boolean updateResults

collapsed

public boolean collapsed

showRanking

public boolean showRanking

showSummary

public boolean showSummary

showTime

public boolean showTime

propNames

public java.lang.String[] propNames

propAlignments

public java.lang.String[] propAlignments

majorVersion

public int majorVersion

minorVersion

public int minorVersion

versionStatus

public int versionStatus

sortProperty

public java.lang.String sortProperty

sortOrder

public boolean sortOrder

classUpdated

public boolean classUpdated
Constructor Detail

WcmSearchState

public WcmSearchState()
Method Detail

clear

public void clear()
Clears the current state


clearSearchData

public void clearSearchData()
Clears selected search data


clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Clone a state object.

Returns:
Object A cloned object
Throws:
java.lang.CloneNotSupportedException - if super don't support it.

getInstance

public static WcmSearchState getInstance(com.filenet.wcm.toolkit.server.dp.WcmSearchDataProvider dp)
                                  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


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