|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.filenet.wcm.toolkit.server.util.WcmStepElementState
Keeps the state of EProcess Step Element information.
Constructor Summary | |
WcmStepElementState()
|
Method Summary | |
void |
clearData()
Cleans up step element state. |
java.lang.String |
getAttachmentId()
Retrieves the current attachment id. |
java.lang.Object |
getAttachmentList(java.lang.String attachmentName)
Retrieves the collection of attachment items for specified attachment name. |
java.util.Iterator |
getAttachments()
Returns the iterator for the keySet in the map. |
java.util.Map |
getAttachmentsMap()
Retrieves the attachments Map object. |
static WcmStepElementState |
getGlobalInstance(WcmDpModule dp)
Overloaded factory method that initialized step element state from global property bag. |
static WcmStepElementState |
getGlobalInstance(WcmDpModule dp,
java.lang.String key)
Overloaded factory method that initialized step element state from global property bag. |
static WcmStepElementState |
getInstance(WcmDpModule dp)
Overloaded factory method that initialized step element state from module property bag |
static WcmStepElementState |
getInstance(WcmDpModule dp,
java.lang.String key)
Overloaded factory method that initialized step element state from module property bag |
static java.lang.String |
getKey(WcmModule module)
return the key of this class |
org.w3c.dom.Document |
getStepElementXML()
Retrieves the Step Element Document object. |
java.lang.String |
getSubject()
Retrieves the current subject. |
java.lang.Object |
getValue(java.lang.String key)
Retrieve a generic object from the state class. |
filenet.vw.api.VWStepElement |
getVWStepElement()
Retrieves the VW Step Element object. |
java.lang.String |
getWorkflowVersion()
Retrieves the current workflow version. |
java.lang.String |
getWorkObjectNumber()
Retrieves the current work object number. |
void |
setAttachmentId(java.lang.String attachmentId)
Sets the current attachment id. |
void |
setAttachmentList(java.lang.String attachmentName,
java.lang.Object itemList)
The itemList will typically be a DOM Document object holding the Attachment XML. |
static void |
setGlobalInstance(WcmDpModule dp,
WcmStepElementState state)
Set state object into global property bag; therefore, getGlobalInstance from now on will return same state object back. |
static void |
setGlobalInstance(WcmDpModule dp,
WcmStepElementState 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(WcmDpModule dp,
WcmStepElementState state)
Set state object into module property. |
static void |
setKey(java.lang.String key,
WcmModule module)
Change the key of this class. |
void |
setStepElementXML(org.w3c.dom.Document domStepElement)
Sets the Step Element object. |
void |
setSubject(java.lang.String subject)
Sets the current subject. |
void |
setValue(java.lang.String key,
java.lang.Object obj)
Add a generic object to the state class. |
void |
setVWStepElement(filenet.vw.api.VWStepElement vwStepElement)
Sets the VW Step Element object. |
void |
setWorkflowVersion(java.lang.String workflowVersion)
Sets the current workflow version. |
void |
setWorkObjectNumber(java.lang.String wobNum)
Sets the current work object number. |
void |
valueBound(WcmDataStore ds,
java.lang.String key)
Call back method called when the object is placed into the data store. |
void |
valueUnbound(WcmDataStore ds,
java.lang.String key)
Call back method called when the object is removed from the data store. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public WcmStepElementState()
Method Detail |
public void clearData()
public void setVWStepElement(filenet.vw.api.VWStepElement vwStepElement)
vwStepElement
- VWStepElement objectpublic filenet.vw.api.VWStepElement getVWStepElement()
public void setStepElementXML(org.w3c.dom.Document domStepElement)
domStepElement
- Document objectpublic org.w3c.dom.Document getStepElementXML()
public void setWorkObjectNumber(java.lang.String wobNum)
wobNum
- String work object numberpublic java.lang.String getWorkObjectNumber()
public void setWorkflowVersion(java.lang.String workflowVersion)
workflowVersion
- String workflow version.public java.lang.String getWorkflowVersion()
public void setAttachmentId(java.lang.String attachmentId)
attachmentId
- String attachment idpublic java.lang.String getAttachmentId()
public void setSubject(java.lang.String subject)
subject
- String subjectpublic java.lang.String getSubject()
public java.lang.Object getAttachmentList(java.lang.String attachmentName) throws java.lang.Exception
attachmentName
- Key used to map object information.
java.lang.Exception
public java.util.Iterator getAttachments() throws java.lang.Exception
java.lang.Exception
public java.util.Map getAttachmentsMap() throws java.lang.Exception
java.lang.Exception
public void setAttachmentList(java.lang.String attachmentName, java.lang.Object itemList) throws java.lang.Exception
attachmentName
- Key used to map object information.itemList
- Object list to store in Map under key.
java.lang.Exception
public static WcmStepElementState getInstance(WcmDpModule dp) throws java.lang.Exception
dp
- EProcessDataProvider which cached state information in its data store.
java.lang.Exception
- If there are problems retrieving data or an invalid parameter.public static WcmStepElementState getInstance(WcmDpModule dp, java.lang.String key) throws java.lang.Exception
dp
- EProcessDataProvider 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(WcmDpModule dp, WcmStepElementState state) throws java.lang.Exception
dp
- Data Provider which cached state information in its data store.state
- WcmStepElementState that has state information.
java.lang.Exception
- If there are problems retrieving data or an invalid parameter.public static WcmStepElementState getGlobalInstance(WcmDpModule dp) throws java.lang.Exception
dp
- Data Provider which cached state information in its data store.
java.lang.Exception
- If there are problems retrieving data or an invalid parameter.public static WcmStepElementState getGlobalInstance(WcmDpModule dp, java.lang.String key) throws java.lang.Exception
dp
- Data Provider 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(WcmDpModule dp, WcmStepElementState state) throws java.lang.Exception
dp
- A Data Provider which cached state information in its data store.state
- WcmStepElementState that has state information from module property.
java.lang.Exception
- If there are problems retrieving data or an invalid parameter.public static void setGlobalInstance(WcmDpModule dp, WcmStepElementState state, java.lang.String key) throws java.lang.Exception
dp
- Data Provider which cached state information in its data store.state
- WcmStepElementState 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 static void setKey(java.lang.String key, WcmModule module) throws java.lang.Exception
key
- - Stringmodule
-
java.lang.Exception
public static java.lang.String getKey(WcmModule module) throws java.lang.Exception
module
-
java.lang.Exception
public void setValue(java.lang.String key, java.lang.Object obj)
key
- - String identifier for the objectobj
- - Object to addpublic java.lang.Object getValue(java.lang.String key)
key
- String identifier for the object
public void valueBound(WcmDataStore ds, java.lang.String key)
valueBound
in interface WcmDataStoreBindingListener
ds
- WcmDataStore objectkey
- String key for data storepublic void valueUnbound(WcmDataStore ds, java.lang.String key)
valueUnbound
in interface WcmDataStoreBindingListener
ds
- WcmDataStore objectkey
- String key for data store
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |