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

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

public class WcmNavigationState
extends java.lang.Object
implements java.lang.Cloneable

This class is used to share information between modules. It has a static method, getInstance, to create this class.


Field Summary
 java.lang.String classID
          Selected folder class id.
 java.lang.String mimeType
           
 BrowseNavigation.WcmNavigationPath navigationPath
          Path of Navigation mode
 java.lang.String objectStoreName
          Object store name for currently selected object
 int objType
          Object type of currently selected item
 java.lang.String pathName
          Site Name for a WCM site
 java.lang.String selectedID
          ID of currently selected object
 java.lang.String selectedLabel
          Label for currently selected object
 java.lang.String sortColumn
          the sort order for the listview
 boolean sortOrder
          the order of the sort
 boolean updateContents
          True if Container Contents needs updating
 boolean updateDefinition
          True if Definition needs updating
 boolean updateNavigation
          True if Navigation Module needs updating
 boolean validated
          A flag that should be set to false in a module's initialize() method.
 java.lang.String vsID
           
 
Method Summary
 void clearData()
          Clears all data values.
 java.lang.Object clone()
          Clone a state object.
 void copyData(WcmNavigationState fromState)
          Copy values from another instance of navState.
 BrowseNavigation.WcmNavigationPath getCurrentPath()
          Will return current WcmFolderNavigation.WcmNavigationPath
static WcmNavigationState getInstance(com.filenet.wcm.toolkit.server.dp.WcmNavigationDataProvider dp)
          Factory method returns an instance of this object to use.
 void moveToParent()
          This rountine moves the navigation up one in the path if possible.
static void setKey(java.lang.String key, com.filenet.wcm.toolkit.server.base.WcmModule module)
          Change the key of this class.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

validated

public boolean validated
A flag that should be set to false in a module's initialize() method.
onStartPage should call the "validateContainer(...)" method of this state object prior to querying.


objType

public int objType
Object type of currently selected item


updateNavigation

public boolean updateNavigation
True if Navigation Module needs updating


updateContents

public boolean updateContents
True if Container Contents needs updating


updateDefinition

public boolean updateDefinition
True if Definition needs updating


objectStoreName

public java.lang.String objectStoreName
Object store name for currently selected object


selectedID

public java.lang.String selectedID
ID of currently selected object


selectedLabel

public java.lang.String selectedLabel
Label for currently selected object


classID

public java.lang.String classID
Selected folder class id.


pathName

public java.lang.String pathName
Site Name for a WCM site


vsID

public java.lang.String vsID

mimeType

public java.lang.String mimeType

navigationPath

public BrowseNavigation.WcmNavigationPath navigationPath
Path of Navigation mode


sortColumn

public java.lang.String sortColumn
the sort order for the listview


sortOrder

public boolean sortOrder
the order of the sort

Method Detail

clearData

public void clearData()
Clears all data values.


copyData

public void copyData(WcmNavigationState fromState)
Copy values from another instance of navState.

Parameters:
fromState -

moveToParent

public void moveToParent()
                  throws java.lang.Exception
This rountine moves the navigation up one in the path if possible.

Throws:
java.lang.Exception

getCurrentPath

public BrowseNavigation.WcmNavigationPath getCurrentPath()
Will return current WcmFolderNavigation.WcmNavigationPath


getInstance

public static WcmNavigationState getInstance(com.filenet.wcm.toolkit.server.dp.WcmNavigationDataProvider dp)
                                      throws java.lang.Exception
Factory method returns an instance of this object to use.

Parameters:
dp - WcmNavigationDataProvider module
Returns:
New instance of WcmNavigationState object, scoped to the data provider
Throws:
java.lang.Exception - If any errors occured

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.

setKey

public static void setKey(java.lang.String key,
                          com.filenet.wcm.toolkit.server.base.WcmModule module)
                   throws java.lang.Exception
Change the key of this class. This can be used to allow multiple instances of this class but with different key.

Parameters:
key - - String
module -
Throws:
java.lang.Exception


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