com.filenet.wcm.apps.server.util.compounddocument
Class CompoundDocumentState

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

public class CompoundDocumentState
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
          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

INFO_MODE

public static final int INFO_MODE
See Also:
Constant Field Values

WIZARD_MODE

public static final int WIZARD_MODE
See Also:
Constant Field Values

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


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


majorVersion

public int majorVersion
Source document major version


minorVersion

public int minorVersion
Source document minor version


versionStatus

public int versionStatus
Source document version status


classID

public java.lang.String classID
Source document class ID


isCompoundDocument

public boolean isCompoundDocument
Is the selected document a compound document

Method Detail

setMode

public void setMode(int operationMode)

getMode

public int getMode()

setIsReadOnly

public void setIsReadOnly(boolean yes)

getIsReadOnly

public boolean getIsReadOnly()

setCRListPageIterator

public void setCRListPageIterator(com.filenet.api.collection.PageIterator it)

getCRListPageIterator

public com.filenet.api.collection.PageIterator getCRListPageIterator()

setCRList

public void setCRList(java.util.List crList)

getCRList

public java.util.List getCRList()

setTempCRList

public void setTempCRList(java.util.List crList)

getTempCRList

public java.util.List getTempCRList()

setLastCRRef

public void setLastCRRef(ComponentRelationshipRef crRef)

getLastCRRef

public ComponentRelationshipRef getLastCRRef()

setModifiedItemMap

public void setModifiedItemMap(org.apache.commons.collections.map.ListOrderedMap itemMap)

getModifiedItemMap

public org.apache.commons.collections.map.ListOrderedMap getModifiedItemMap()

setTempModifiedItemMap

public void setTempModifiedItemMap(org.apache.commons.collections.map.ListOrderedMap itemMap)

getTempModifiedItemMap

public org.apache.commons.collections.map.ListOrderedMap getTempModifiedItemMap()

setNewItemMap

public void setNewItemMap(org.apache.commons.collections.map.ListOrderedMap itemMap)

getNewItemMap

public org.apache.commons.collections.map.ListOrderedMap getNewItemMap()

setTempNewItemMap

public void setTempNewItemMap(org.apache.commons.collections.map.ListOrderedMap itemMap)

getTempNewItemMap

public org.apache.commons.collections.map.ListOrderedMap getTempNewItemMap()

getInstance

public static CompoundDocumentState 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 - CompoundDocumentDataProvider 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.

setInstance

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

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

getInstance

public static CompoundDocumentState 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 global property bag.

Parameters:
dp - CompoundDocumentDataProvider which cached state information in its data store.
key - Allow different states coexist.
Returns:
CompoundDocumentState, returns itself back.
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

setParentDocumentsXML

public void setParentDocumentsXML(org.w3c.dom.Document xml)

getParentDocumentsXML

public org.w3c.dom.Document getParentDocumentsXML()

setComponentRelationshipsXML

public void setComponentRelationshipsXML(org.w3c.dom.Document xml)

getComponentRelationshipsXML

public org.w3c.dom.Document getComponentRelationshipsXML()

setChildDocumentsXML

public void setChildDocumentsXML(org.w3c.dom.Document xml)

getChildDocumentsXML

public org.w3c.dom.Document getChildDocumentsXML()

getPathItems

public java.util.Vector getPathItems()

setPathItems

public void setPathItems(java.util.Vector pathItems)

getCurrentPage

public int getCurrentPage()

setCurrentPage

public void setCurrentPage(int page)

getPageSize

public int getPageSize()

setPageSize

public void setPageSize(int pageSize)

getSortOrder

public boolean getSortOrder()

setSortOrder

public void setSortOrder(boolean ascending)

setValue

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

getValue

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

clear

public void clear()


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