|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.filenet.wcm.apps.server.util.WcmAuthoringState
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 |
public static final java.lang.String KEY
public java.lang.String objectStoreName
public java.lang.String selectedID
public java.lang.String selectedLabel
public java.lang.String verSerID
public java.lang.String objectLabel
public java.lang.String objectID
public int publishType
public java.lang.String originalClassID
public java.lang.String classID
public java.lang.String propertySymname
public java.lang.String choiceID
public java.lang.String path
public java.lang.String mode
public int objectType
public java.lang.String mimeType
public int majorVersion
public int minorVersion
public int versionStatus
public java.lang.String applyStateID
Method Detail |
public void clearObjectStoreData()
public void initFromPageParams(com.filenet.wcm.toolkit.server.base.WcmController controller) throws java.lang.Exception
controller
- Controller
java.lang.Exception
- If there are problems retrieving data or an invalid parameter.public static WcmAuthoringState getInstance(com.filenet.wcm.toolkit.server.base.WcmDpModuleInterface dp, com.filenet.wcm.toolkit.server.base.WcmController controller) throws java.lang.Exception
dp
- AuthoringDataProvider which cached state information in its data store.controller
- Controller
java.lang.Exception
- If there are problems retrieving data or an invalid parameter.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
dp
- AuthoringDataProvider which cached state information in its data store.controller
- Controllerkey
- Allow different states coexist.
java.lang.Exception
- If there are problems retrieving data or an invalid parameter.public static WcmAuthoringState getInstance(com.filenet.wcm.toolkit.server.base.WcmDpModuleInterface dp) throws java.lang.Exception
dp
- AuthoringDataProvider which cached state information in its data store.
java.lang.Exception
- If there are problems retrieving data or an invalid parameter.public static WcmAuthoringState getInstance(com.filenet.wcm.toolkit.server.base.WcmDpModuleInterface dp, java.lang.String key) throws java.lang.Exception
dp
- AuthoringDataProvider which cached state information in its data store.key
- Allow different states coexist.
java.lang.Exception
- If there are problems retrieving data or an invalid parameter.public static void setInstance(com.filenet.wcm.toolkit.server.base.WcmDpModuleInterface dp, WcmAuthoringState state) throws java.lang.Exception
dp
- WcmAuthoringDataProvider which cached state information in its data store.state
- WcmAuthoringState that has state information.
java.lang.Exception
- If there are problems retrieving data or an invalid parameter.public static WcmAuthoringState getGlobalInstance(com.filenet.wcm.toolkit.server.base.WcmDpModuleInterface dp) throws java.lang.Exception
dp
- AuthoringDataProvider which cached state information in its data store.
java.lang.Exception
- If there are problems retrieving data or an invalid parameter.public static WcmAuthoringState getGlobalInstance(com.filenet.wcm.toolkit.server.base.WcmDpModuleInterface dp, java.lang.String key) throws java.lang.Exception
dp
- AuthoringDataProvider which cached state information in its data store.key
- Allow different states coexist.
java.lang.Exception
- If there are problems retrieving data or an invalid parameter.public static void setGlobalInstance(com.filenet.wcm.toolkit.server.base.WcmDpModuleInterface dp, WcmAuthoringState state) throws java.lang.Exception
dp
- AuthoringDataProvider which cached state information in its data store.state
- WcmAuthoringState that has state information from module property.
java.lang.Exception
- If there are problems retrieving data or an invalid parameter.public static void setGlobalInstance(com.filenet.wcm.toolkit.server.base.WcmDpModuleInterface dp, WcmAuthoringState state, java.lang.String key) throws java.lang.Exception
dp
- AuthoringDataProvider which cached state information in its data store.state
- WcmAuthoringState that has state information from module property.key
- Allow different states coexist.
java.lang.Exception
- If there are problems retrieving data or an invalid parameter.public java.lang.Object clone() throws java.lang.CloneNotSupportedException
java.lang.CloneNotSupportedException
- if super don't support it.public static void setKey(java.lang.String key, com.filenet.wcm.toolkit.server.base.WcmModule module) throws java.lang.Exception
key
- - Stringmodule
-
java.lang.Exception
public static java.lang.String getKey(com.filenet.wcm.toolkit.server.base.WcmModule module) throws java.lang.Exception
module
-
java.lang.Exception
public void setValue(java.lang.String key, java.lang.Object obj)
public java.lang.Object getValue(java.lang.String key)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |