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

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

public class WcmAuthoringState
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 applyStateID
          Selected Security Template applystateid of currently selected item
 java.lang.String choiceID
          Current selected property's choice list ID.
 java.lang.String classID
          Current selected document class ID.
static java.lang.String KEY
           
 int majorVersion
          Major version of currently selected item
 java.lang.String mimeType
          Mime type of currently selected item
 int minorVersion
          Minor version of currently selected item
 java.lang.String mode
          For setting readonly mode
 java.lang.String objectID
          Source document ID
 java.lang.String objectLabel
          Document title for currently selected object - used in Publishing wizard
 java.lang.String objectStoreName
          Object store name for currently selected object
 int objectType
          Object type of currently selected item
 java.lang.String originalClassID
          Original Document class ID.
 java.lang.String path
          Folder selection path.
 java.lang.String propertySymname
          Current selected property Symbolic Name.
 int publishType
          Publishing mode - 1 - republish, 2 - publish
 java.lang.String selectedID
          ID of currently selected object
 java.lang.String selectedLabel
          Label for currently selected object
 java.lang.String verSerID
          Version series ID for currently selected object
 int versionStatus
          Version Status of currently selected item
 
Method Summary
 void clearObjectStoreData()
          Clears data.
 java.lang.Object clone()
          Clone a state object.
static WcmAuthoringState getGlobalInstance(com.filenet.wcm.toolkit.server.base.WcmDpModuleInterface dp)
          Overloaded factory method that initialized authoring state from global property bag.
static WcmAuthoringState getGlobalInstance(com.filenet.wcm.toolkit.server.base.WcmDpModuleInterface dp, java.lang.String key)
          Overloaded factory method that initialized authoring state from global property bag.
static WcmAuthoringState getInstance(com.filenet.wcm.toolkit.server.base.WcmDpModuleInterface dp)
          Overloaded factory method that initialized authoring state from module property bag
static WcmAuthoringState getInstance(com.filenet.wcm.toolkit.server.base.WcmDpModuleInterface dp, java.lang.String key)
          Overloaded factory method that initialized authoring state from module property bag
static WcmAuthoringState getInstance(com.filenet.wcm.toolkit.server.base.WcmDpModuleInterface dp, com.filenet.wcm.toolkit.server.base.WcmController controller)
          Overloaded factory method that initialized authoring state from controller page data.
static WcmAuthoringState getInstance(com.filenet.wcm.toolkit.server.base.WcmDpModuleInterface dp, com.filenet.wcm.toolkit.server.base.WcmController controller, java.lang.String key)
          Overloaded factory method that initialized authoring state from controller page data.
static java.lang.String getKey(com.filenet.wcm.toolkit.server.base.WcmModule module)
          return the key of this class
 java.lang.Object getValue(java.lang.String key)
           
 void initFromPageParams(com.filenet.wcm.toolkit.server.base.WcmController controller)
          Initializes member variables from controller's page data.
static void setGlobalInstance(com.filenet.wcm.toolkit.server.base.WcmDpModuleInterface dp, WcmAuthoringState state)
          Set state object into global property bag; therefore, getGlobalInstance from now on will return same state object back.
static void setGlobalInstance(com.filenet.wcm.toolkit.server.base.WcmDpModuleInterface dp, WcmAuthoringState state, java.lang.String key)
          Set state object into global property bag; therefore, getGlobalInstance from now on will return same state object back.
static void setInstance(com.filenet.wcm.toolkit.server.base.WcmDpModuleInterface dp, WcmAuthoringState state)
          Set state object into module property.
static void setKey(java.lang.String key, com.filenet.wcm.toolkit.server.base.WcmModule module)
          Change the key of this class.
 void setValue(java.lang.String key, java.lang.Object obj)
           
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

KEY

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

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


verSerID

public java.lang.String verSerID
Version series ID for currently selected object


objectLabel

public java.lang.String objectLabel
Document title for currently selected object - used in Publishing wizard


objectID

public java.lang.String objectID
Source document ID


publishType

public int publishType
Publishing mode - 1 - republish, 2 - publish


originalClassID

public java.lang.String originalClassID
Original Document class ID.


classID

public java.lang.String classID
Current selected document class ID.


propertySymname

public java.lang.String propertySymname
Current selected property Symbolic Name.


choiceID

public java.lang.String choiceID
Current selected property's choice list ID.


path

public java.lang.String path
Folder selection path.


mode

public java.lang.String mode
For setting readonly mode


objectType

public int objectType
Object type of currently selected item


mimeType

public java.lang.String mimeType
Mime type of currently selected item


majorVersion

public int majorVersion
Major version of currently selected item


minorVersion

public int minorVersion
Minor version of currently selected item


versionStatus

public int versionStatus
Version Status of currently selected item


applyStateID

public java.lang.String applyStateID
Selected Security Template applystateid of currently selected item

Method Detail

clearObjectStoreData

public void clearObjectStoreData()
Clears data.


initFromPageParams

public void initFromPageParams(com.filenet.wcm.toolkit.server.base.WcmController controller)
                        throws java.lang.Exception
Initializes member variables from controller's page data.

Parameters:
controller - Controller
Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.

getInstance

public static WcmAuthoringState getInstance(com.filenet.wcm.toolkit.server.base.WcmDpModuleInterface dp,
                                            com.filenet.wcm.toolkit.server.base.WcmController controller)
                                     throws java.lang.Exception
Overloaded factory method that initialized authoring state from controller page data.

Parameters:
dp - AuthoringDataProvider which cached state information in its data store.
controller - Controller
Returns:
WcnAuthoringState, returns itself back.
Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.

getInstance

public static WcmAuthoringState getInstance(com.filenet.wcm.toolkit.server.base.WcmDpModuleInterface dp,
                                            com.filenet.wcm.toolkit.server.base.WcmController controller,
                                            java.lang.String key)
                                     throws java.lang.Exception
Overloaded factory method that initialized authoring state from controller page data.

Parameters:
dp - AuthoringDataProvider which cached state information in its data store.
controller - Controller
key - Allow different states coexist.
Returns:
WcnAuthoringState, returns itself back.
Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.

getInstance

public static WcmAuthoringState getInstance(com.filenet.wcm.toolkit.server.base.WcmDpModuleInterface dp)
                                     throws java.lang.Exception
Overloaded factory method that initialized authoring state from module property bag

Parameters:
dp - AuthoringDataProvider which cached state information in its data store.
Returns:
WcnAuthoringState, returns itself back.
Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.

getInstance

public static WcmAuthoringState getInstance(com.filenet.wcm.toolkit.server.base.WcmDpModuleInterface dp,
                                            java.lang.String key)
                                     throws java.lang.Exception
Overloaded factory method that initialized authoring state from module property bag

Parameters:
dp - AuthoringDataProvider which cached state information in its data store.
key - Allow different states coexist.
Returns:
WcnAuthoringState, returns itself back.
Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.

setInstance

public static void setInstance(com.filenet.wcm.toolkit.server.base.WcmDpModuleInterface dp,
                               WcmAuthoringState state)
                        throws java.lang.Exception
Set state object into module property.

Parameters:
dp - WcmAuthoringDataProvider which cached state information in its data store.
state - WcmAuthoringState that has state information.
Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.

getGlobalInstance

public static WcmAuthoringState getGlobalInstance(com.filenet.wcm.toolkit.server.base.WcmDpModuleInterface dp)
                                           throws java.lang.Exception
Overloaded factory method that initialized authoring state from global property bag.

Parameters:
dp - AuthoringDataProvider which cached state information in its data store.
Returns:
WcnAuthoringState, returns itself back.
Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.

getGlobalInstance

public static WcmAuthoringState getGlobalInstance(com.filenet.wcm.toolkit.server.base.WcmDpModuleInterface dp,
                                                  java.lang.String key)
                                           throws java.lang.Exception
Overloaded factory method that initialized authoring state from global property bag.

Parameters:
dp - AuthoringDataProvider which cached state information in its data store.
key - Allow different states coexist.
Returns:
WcnAuthoringState, returns itself back.
Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.

setGlobalInstance

public static void setGlobalInstance(com.filenet.wcm.toolkit.server.base.WcmDpModuleInterface dp,
                                     WcmAuthoringState state)
                              throws java.lang.Exception
Set state object into global property bag; therefore, getGlobalInstance from now on will return same state object back. This is used between a local state and global state conversion.

Parameters:
dp - AuthoringDataProvider which cached state information in its data store.
state - WcmAuthoringState that has state information from module property.
Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.

setGlobalInstance

public static void setGlobalInstance(com.filenet.wcm.toolkit.server.base.WcmDpModuleInterface dp,
                                     WcmAuthoringState state,
                                     java.lang.String key)
                              throws java.lang.Exception
Set state object into global property bag; therefore, getGlobalInstance from now on will return same state object back. This is used between a local state and global state conversion.

Parameters:
dp - AuthoringDataProvider which cached state information in its data store.
state - WcmAuthoringState that has state information from module property.
key - Allow different states coexist.
Throws:
java.lang.Exception - If there are problems retrieving data or an invalid parameter.

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

getKey

public static java.lang.String getKey(com.filenet.wcm.toolkit.server.base.WcmModule module)
                               throws java.lang.Exception
return the key of this class

Parameters:
module -
Returns:
- String, key of this class
Throws:
java.lang.Exception

setValue

public void setValue(java.lang.String key,
                     java.lang.Object obj)

getValue

public java.lang.Object getValue(java.lang.String key)


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