|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.filenet.wcm.apps.server.util.compounddocument.CompoundDocumentState
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
Source document class ID |
static int |
INFO_MODE
|
boolean |
isCompoundDocument
Is the selected document a compound document |
static java.lang.String |
KEY
|
int |
majorVersion
Source document major version |
int |
minorVersion
Source document minor version |
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 |
java.lang.String |
selectedLabel
Label for currently selected object |
java.lang.String |
verSerID
Version series ID for currently selected object |
int |
versionStatus
Source document version status |
static int |
WIZARD_MODE
|
Method Summary | |
void |
clear()
|
java.lang.Object |
clone()
Clone a state object. |
org.w3c.dom.Document |
getChildDocumentsXML()
|
org.w3c.dom.Document |
getComponentRelationshipsXML()
|
java.util.List |
getCRList()
|
com.filenet.api.collection.PageIterator |
getCRListPageIterator()
|
int |
getCurrentPage()
|
static CompoundDocumentState |
getInstance(com.filenet.wcm.toolkit.server.base.WcmDpModuleInterface dp)
Overloaded factory method that initialized authoring state from module property bag |
static CompoundDocumentState |
getInstance(com.filenet.wcm.toolkit.server.base.WcmDpModuleInterface dp,
java.lang.String key)
Overloaded factory method that initialized authoring state from global property bag. |
boolean |
getIsReadOnly()
|
static java.lang.String |
getKey(com.filenet.wcm.toolkit.server.base.WcmModule module)
return the key of this class |
ComponentRelationshipRef |
getLastCRRef()
|
int |
getMode()
|
org.apache.commons.collections.map.ListOrderedMap |
getModifiedItemMap()
|
org.apache.commons.collections.map.ListOrderedMap |
getNewItemMap()
|
int |
getPageSize()
|
org.w3c.dom.Document |
getParentDocumentsXML()
|
java.util.Vector |
getPathItems()
|
boolean |
getSortOrder()
|
java.util.List |
getTempCRList()
|
org.apache.commons.collections.map.ListOrderedMap |
getTempModifiedItemMap()
|
org.apache.commons.collections.map.ListOrderedMap |
getTempNewItemMap()
|
java.lang.Object |
getValue(java.lang.String key)
|
void |
setChildDocumentsXML(org.w3c.dom.Document xml)
|
void |
setComponentRelationshipsXML(org.w3c.dom.Document xml)
|
void |
setCRList(java.util.List crList)
|
void |
setCRListPageIterator(com.filenet.api.collection.PageIterator it)
|
void |
setCurrentPage(int page)
|
static void |
setInstance(com.filenet.wcm.toolkit.server.base.WcmDpModuleInterface dp,
CompoundDocumentState state)
Set state object into module property. |
void |
setIsReadOnly(boolean yes)
|
static void |
setKey(java.lang.String key,
com.filenet.wcm.toolkit.server.base.WcmModule module)
Change the key of this class. |
void |
setLastCRRef(ComponentRelationshipRef crRef)
|
void |
setMode(int operationMode)
|
void |
setModifiedItemMap(org.apache.commons.collections.map.ListOrderedMap itemMap)
|
void |
setNewItemMap(org.apache.commons.collections.map.ListOrderedMap itemMap)
|
void |
setPageSize(int pageSize)
|
void |
setParentDocumentsXML(org.w3c.dom.Document xml)
|
void |
setPathItems(java.util.Vector pathItems)
|
void |
setSortOrder(boolean ascending)
|
void |
setTempCRList(java.util.List crList)
|
void |
setTempModifiedItemMap(org.apache.commons.collections.map.ListOrderedMap itemMap)
|
void |
setTempNewItemMap(org.apache.commons.collections.map.ListOrderedMap itemMap)
|
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 int INFO_MODE
public static final int WIZARD_MODE
public static final java.lang.String KEY
public java.lang.String objectStoreName
public java.lang.String selectedLabel
public java.lang.String verSerID
public java.lang.String objectLabel
public java.lang.String objectID
public int majorVersion
public int minorVersion
public int versionStatus
public java.lang.String classID
public boolean isCompoundDocument
Method Detail |
public void setMode(int operationMode)
public int getMode()
public void setIsReadOnly(boolean yes)
public boolean getIsReadOnly()
public void setCRListPageIterator(com.filenet.api.collection.PageIterator it)
public com.filenet.api.collection.PageIterator getCRListPageIterator()
public void setCRList(java.util.List crList)
public java.util.List getCRList()
public void setTempCRList(java.util.List crList)
public java.util.List getTempCRList()
public void setLastCRRef(ComponentRelationshipRef crRef)
public ComponentRelationshipRef getLastCRRef()
public void setModifiedItemMap(org.apache.commons.collections.map.ListOrderedMap itemMap)
public org.apache.commons.collections.map.ListOrderedMap getModifiedItemMap()
public void setTempModifiedItemMap(org.apache.commons.collections.map.ListOrderedMap itemMap)
public org.apache.commons.collections.map.ListOrderedMap getTempModifiedItemMap()
public void setNewItemMap(org.apache.commons.collections.map.ListOrderedMap itemMap)
public org.apache.commons.collections.map.ListOrderedMap getNewItemMap()
public void setTempNewItemMap(org.apache.commons.collections.map.ListOrderedMap itemMap)
public org.apache.commons.collections.map.ListOrderedMap getTempNewItemMap()
public static CompoundDocumentState getInstance(com.filenet.wcm.toolkit.server.base.WcmDpModuleInterface dp) throws java.lang.Exception
dp
- CompoundDocumentDataProvider which cached state information in its data store.
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, CompoundDocumentState state) throws java.lang.Exception
dp
- CompoundDocumentDataProvider which cached state information in its data store.state
- CompoundDocumentState that has state information.
java.lang.Exception
- If there are problems retrieving data or an invalid parameter.public static CompoundDocumentState getInstance(com.filenet.wcm.toolkit.server.base.WcmDpModuleInterface dp, java.lang.String key) throws java.lang.Exception
dp
- CompoundDocumentDataProvider 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 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 setParentDocumentsXML(org.w3c.dom.Document xml)
public org.w3c.dom.Document getParentDocumentsXML()
public void setComponentRelationshipsXML(org.w3c.dom.Document xml)
public org.w3c.dom.Document getComponentRelationshipsXML()
public void setChildDocumentsXML(org.w3c.dom.Document xml)
public org.w3c.dom.Document getChildDocumentsXML()
public java.util.Vector getPathItems()
public void setPathItems(java.util.Vector pathItems)
public int getCurrentPage()
public void setCurrentPage(int page)
public int getPageSize()
public void setPageSize(int pageSize)
public boolean getSortOrder()
public void setSortOrder(boolean ascending)
public void setValue(java.lang.String key, java.lang.Object obj)
public java.lang.Object getValue(java.lang.String key)
public void clear()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |