|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.filenet.wcm.toolkit.server.base.WcmDpContainer
com.filenet.wcm.toolkit.server.base.WcmModule
com.filenet.wcm.toolkit.server.util.WcmEProcessUtil
Utility class to support getting attachment information for the eProcess page.
Field Summary | |
static java.util.Map |
BPM_NS
|
static java.lang.String |
MIMETYPE_REFERENCE
Defines the mimetype for an external reference attachment item. |
static java.lang.String |
MIMETYPE_UNASSIGNED
Defines the mimetype for an unassigned attachment item. |
static java.lang.String |
MIMETYPE_UNRESOLVED
Defines the mimetype for an unresolved attachment item. |
static java.lang.String |
MIMETYPE_WORKFLOW
Defines the mimetype for a workflow definition. |
static java.lang.String |
MIMETYPE_XPDL_WORKFLOW
|
static java.lang.String |
TYPE_UNASSIGNED
Defines the unassigned attachment type. |
static java.lang.String |
TYPE_UNC
Defines the UNC attachment type. |
static java.lang.String |
TYPE_URL
Defines the URL attachment type. |
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule |
locale, NAME_DELIMITER |
Constructor Summary | |
WcmEProcessUtil()
|
Method Summary | |
void |
addAttachmentItemXML(java.lang.String objectStoreName,
java.lang.String objectId,
java.lang.String verSerId,
java.lang.String objectType,
java.lang.String referenceId,
java.lang.String attachmentName,
java.lang.Object attachmentsXML)
Adds an attachment item into the Attachment Items list. |
void |
addItemToAttachmentXML(java.lang.String objectStoreName,
java.lang.String objectId,
java.lang.String verSerId,
java.lang.String objectType,
java.lang.String referenceId,
java.lang.String attachmentName,
org.w3c.dom.Document stepAttachmentsXML)
Adds an attachment item into the Attachment Items list. |
java.lang.String |
addProcessorInformation(org.w3c.dom.Document domObjectXML,
org.w3c.dom.Node nodeObject,
java.util.List policyProcessors)
Get the processor information for the current object. |
java.lang.String |
addProcessorInformation(org.w3c.dom.Document domObjectXML,
org.w3c.dom.Node nodeObject,
org.w3c.dom.Node nodeWCMNamespace)
Deprecated. use addProcessorInformation with new List policyProcessors parameter |
java.lang.String |
addProcessorInformation(org.w3c.dom.Document domObjectXML,
org.w3c.dom.Node nodeObject,
org.w3c.dom.Node nodeWCMNamespace,
java.util.List policyProcessors)
Deprecated. use addProcessorInformation with new List policyProcessors parameter |
void |
addReferenceAttachmentItemXML(java.lang.String type,
java.lang.String path,
java.lang.String referenceId,
java.lang.String attachmentName,
java.lang.Object attachmentsXML)
Adds an reference attachment item into the Attachment Items list. |
void |
addReferenceItemToAttachmentXML(java.lang.String type,
java.lang.String path,
java.lang.String referenceId,
java.lang.String attachmentName,
org.w3c.dom.Document stepAttachmentsXML)
Adds an reference attachment item into the Attachment Items list. |
boolean |
doCreateAttachmentItems(java.lang.String attachmentName,
org.w3c.dom.Document stepAttachmentsXML)
Searches the Attachment XML to find individual attachment items, and calls back into the eProcess data provider to add the attachment information to the step element. |
boolean |
doCreateAttachments(java.lang.String attachmentName,
java.lang.Object attachmentsXML)
Searches the Attachment XML to find individual attachments, and calls back into the eProcess data provider to add the attachment information to the step element. |
boolean |
doProcessPropertyMap(org.w3c.dom.Document domStepElementXML,
java.lang.String propertyMap,
java.lang.String attachmentId)
Processes the property map. |
void |
doProcessSubscriptions(org.w3c.dom.Document domSubscriptionXML,
java.lang.String objectStoreName,
java.lang.String objectId,
java.lang.String versionSeriesId,
int objectType)
Deprecated. use doProcessSubscriptions method with new List policyProcessors parameter |
void |
doProcessSubscriptions(org.w3c.dom.Document domSubscriptionXML,
java.lang.String objectStoreName,
java.lang.String objectId,
java.lang.String versionSeriesId,
int objectType,
java.util.List policyProcessors)
Processes the Workflow subscriptions. |
boolean |
fetchAllAttachmentItemsXML(org.w3c.dom.Document stepAttachmentsXML,
org.w3c.dom.Document stepElementXML,
boolean fullLoop)
Fetch the attachment items associated with all the workflow attachments. |
boolean |
fetchAttachmentItemsExXML(java.lang.String attachmentName,
org.w3c.dom.Document stepAttachmentsXML,
org.w3c.dom.Document stepElementXML)
Get the list of attachment items for the specified attachment. |
void |
fetchAttachmentItemsXML(java.lang.String attachmentName,
org.w3c.dom.Document stepAttachmentsXML,
org.w3c.dom.Document stepElementXML)
Get the list of attachment items for the specified attachment. |
boolean |
getAttachmentArrayType(java.lang.String attachmentName)
Get the specified attachments array type. |
java.lang.String |
getAttachmentDisplayState(java.lang.String attachmentName,
org.w3c.dom.Document stepAttachmentsXML)
Get the display state of the attachment items list. |
java.lang.Object |
getAttachmentItemsXML(java.lang.String attachmentName,
java.lang.Object stepElementXML)
Gets the list of attachment items for the specified attachment name. |
boolean |
getAttachmentMode(java.lang.String attachmentName)
Get the specified attachments edit mode. |
java.lang.String |
getAttachmentName(java.lang.String objectStoreName,
java.lang.String id,
java.lang.String type)
Get the name of the attachment. |
org.w3c.dom.Document |
getDocumentFormTemplateAttachmentsXML(java.lang.String attachmentName)
Get the list of document form template attachment items for the specified attachment name. |
java.lang.String |
getNodeValue(org.w3c.dom.Node current,
java.lang.String xPathExpression,
org.w3c.dom.Node namespace)
Deprecated. use XMLNodeUtil utility class for getting node information |
org.w3c.dom.Document |
getObjectPropertiesXML(java.lang.String objectStoreName,
java.lang.String objectId,
java.lang.String verSerId,
int objectType)
Used the passed in id's to retrieve the requested object propery xml. |
org.w3c.dom.Document |
getStepAttachmentsXML(org.w3c.dom.Document stepElementXML)
Get the list of attachments for the step element. |
void |
initialize()
Initializes the class data. |
void |
removeAttachmentItemXML(java.lang.String objectStoreName,
java.lang.String objectId,
java.lang.String verSerId,
java.lang.String objectType,
java.lang.String position,
boolean unassign,
java.lang.String attachmentName,
java.lang.Object attachmentsXML)
Removes or unassigns the selected attachment from the current attachments list. |
void |
removeItemFromAttachmentXML(java.lang.String objectStoreName,
java.lang.String objectId,
java.lang.String verSerId,
java.lang.String objectType,
java.lang.String position,
boolean unassign,
java.lang.String attachmentName,
org.w3c.dom.Document stepAttachmentsXML)
Removes or unassigns the selected attachment from the current attachments list. |
void |
setAttachmentDisplayState(java.lang.String mode,
java.lang.String attachmentName,
org.w3c.dom.Document stepAttachmentsXML)
Set the display state of the attachment items list. |
void |
setNameProperties(java.lang.String documentNameProperty,
java.lang.String folderNameProperty,
java.lang.String customObjectNameProperty)
Set the name properties for a specified object type. |
void |
setQueryProperties(java.lang.String[] properties)
Set the properties required to display the items in the list view. |
void |
updateAttachmentItemXML(java.lang.String objectStoreName,
java.lang.String verSerId,
java.lang.String objectId,
java.lang.String objectType,
java.lang.Object attachmentsXML)
Updates the selected attachment from the current attachments list. |
void |
updateItemInAttachmentXML(java.lang.String objectStoreName,
java.lang.String verSerId,
java.lang.String objectId,
java.lang.String objectType,
java.lang.String attachmentName,
org.w3c.dom.Document stepAttachmentsXML)
Updates the selected attachment from the current attachments list. |
void |
updateItemsInAttachment(org.w3c.dom.Document stepAttachmentsXML,
java.lang.String attachmentName)
Helper method that updated all the attachment items in the attachment list. |
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmModule |
addChild, addChild, addChild, cleanup, debugTrace, getClassProperty, getClassProperty, getClassPropertyKeys, getConfiguration, getController, getDataStore, getModuleProperty, getModuleProperty, getModuleProperty, getModuleProperty, getModulePropertyKeys, getName, getParent, getWindowProperty, getWindowProperty, persist, queryDataProvider, setClassProperty, setClassProperty, setController, setModuleProperty, setModuleProperty, setName, setParent, setPortletParent, setWindowProperty |
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmDpContainer |
addDataProvider, addDataProvider |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface |
addDataProvider |
Field Detail |
public static final java.lang.String TYPE_UNASSIGNED
public static final java.lang.String TYPE_UNC
public static final java.lang.String TYPE_URL
public static final java.lang.String MIMETYPE_UNASSIGNED
public static final java.lang.String MIMETYPE_UNRESOLVED
public static final java.lang.String MIMETYPE_REFERENCE
public static final java.lang.String MIMETYPE_WORKFLOW
public static final java.lang.String MIMETYPE_XPDL_WORKFLOW
public static java.util.Map BPM_NS
Constructor Detail |
public WcmEProcessUtil() throws java.lang.Exception
Method Detail |
public void initialize() throws java.lang.Exception
initialize
in interface WcmModuleInterface
initialize
in class WcmModule
java.lang.Exception
- If there are problems.public java.lang.Object getAttachmentItemsXML(java.lang.String attachmentName, java.lang.Object stepElementXML) throws java.lang.Exception
attachmentName
- The Attachment name.stepElementXML
- The eProcess StepElement information as XML loaded into org.w3c.dom.Document.
java.lang.Exception
- Thrown when there are errors.public org.w3c.dom.Document getStepAttachmentsXML(org.w3c.dom.Document stepElementXML) throws java.lang.Exception
stepElementXML
- The eProcess StepElement information as XML loaded into org.w3c.dom.Document.
java.lang.Exception
- Thrown when there are errors.public void fetchAttachmentItemsXML(java.lang.String attachmentName, org.w3c.dom.Document stepAttachmentsXML, org.w3c.dom.Document stepElementXML) throws java.lang.Exception
attachmentName
- String hold ing the attachment name to retrieve items from.stepAttachmentsXML
- Document object holding list of attachment items to be rendered in list viewstepElementXML
- The eProcess StepElement information as XML loaded into org.w3c.dom.Document.
java.lang.Exception
- Thrown when there are errors.public boolean fetchAllAttachmentItemsXML(org.w3c.dom.Document stepAttachmentsXML, org.w3c.dom.Document stepElementXML, boolean fullLoop) throws java.lang.Exception
stepAttachmentsXML
- Document object holding Workflow Attachments xmlstepElementXML
- Document object holding Workflow Step Element xmlfullLoop
- boolean True if the routine should process all attachment items in all attachments
False if loop should stop once it finds an attachment item that is not and Entry Template
(this option was coded specifically for the new attachment page behavior).
java.lang.Exception
- Thrown when there are errors.public boolean fetchAttachmentItemsExXML(java.lang.String attachmentName, org.w3c.dom.Document stepAttachmentsXML, org.w3c.dom.Document stepElementXML) throws java.lang.Exception
attachmentName
- String hold ing the attachment name to retrieve items from.stepAttachmentsXML
- Document object holding list of attachment items to be rendered in list viewstepElementXML
- The eProcess StepElement information as XML loaded into org.w3c.dom.Document.
java.lang.Exception
- Thrown when there are errors.public void setAttachmentDisplayState(java.lang.String mode, java.lang.String attachmentName, org.w3c.dom.Document stepAttachmentsXML) throws java.lang.Exception
mode
- String holding display state "Expand" or "Collapse"attachmentName
- String holding specified attachmentstepAttachmentsXML
- Document object holding attachments
java.lang.Exception
- Thrown when there are errors.public java.lang.String getAttachmentDisplayState(java.lang.String attachmentName, org.w3c.dom.Document stepAttachmentsXML) throws java.lang.Exception
attachmentName
- String holding specified attachmentstepAttachmentsXML
- Document object holding attachments
java.lang.Exception
- Thrown when there are errors.public org.w3c.dom.Document getDocumentFormTemplateAttachmentsXML(java.lang.String attachmentName) throws java.lang.Exception
attachmentName
- The Attachment name.
java.lang.Exception
- Thrown when there are errors.public boolean getAttachmentArrayType(java.lang.String attachmentName) throws java.lang.Exception
attachmentName
- String attachment name
java.lang.Exception
- Thrown when there are errors.public boolean getAttachmentMode(java.lang.String attachmentName) throws java.lang.Exception
attachmentName
- String attachment name
java.lang.Exception
- Thrown when there are errors.public void addAttachmentItemXML(java.lang.String objectStoreName, java.lang.String objectId, java.lang.String verSerId, java.lang.String objectType, java.lang.String referenceId, java.lang.String attachmentName, java.lang.Object attachmentsXML) throws java.lang.Exception
objectStoreName
- ObjectStore Name of item to add.objectId
- Object Id of item to add.verSerId
- Version Series Id of item to add.objectType
- Object type of item to add.referenceId
- Object Id of item to insert current node before (may be null, in which case add to end).attachmentName
- The name of the attachment.attachmentsXML
- Holds the cached list of attachment items.
java.lang.Exception
- Thrown when there are errors.public void addItemToAttachmentXML(java.lang.String objectStoreName, java.lang.String objectId, java.lang.String verSerId, java.lang.String objectType, java.lang.String referenceId, java.lang.String attachmentName, org.w3c.dom.Document stepAttachmentsXML) throws java.lang.Exception
objectStoreName
- ObjectStore Name of item to add.objectId
- Object Id of item to add.verSerId
- Version Series Id of item to add.objectType
- Object type of item to add.referenceId
- Object Id of item to insert current node before (may be null, in which case add to end).attachmentName
- The name of the attachment.stepAttachmentsXML
- Holds the cached list of attachment items.
java.lang.Exception
- Thrown when there are errors.public void addReferenceAttachmentItemXML(java.lang.String type, java.lang.String path, java.lang.String referenceId, java.lang.String attachmentName, java.lang.Object attachmentsXML) throws java.lang.Exception
type
- Type of reference attachment "UNC" or "URL".path
- Path to reference file.referenceId
- Object Id of item to insert current node before (may be null, in which case add to end).attachmentName
- Name of AttachmentattachmentsXML
- Holds the cached list of attachment items.
java.lang.Exception
- Thrown when there are errors.public void addReferenceItemToAttachmentXML(java.lang.String type, java.lang.String path, java.lang.String referenceId, java.lang.String attachmentName, org.w3c.dom.Document stepAttachmentsXML) throws java.lang.Exception
type
- Type of reference attachment "UNC" or "URL".path
- Path to reference file.referenceId
- Object Id of item to insert current node before (may be null, in which case add to end).attachmentName
- Name of AttachmentstepAttachmentsXML
- Holds the cached list of attachment items.
java.lang.Exception
- Thrown when there are errors.public void removeAttachmentItemXML(java.lang.String objectStoreName, java.lang.String objectId, java.lang.String verSerId, java.lang.String objectType, java.lang.String position, boolean unassign, java.lang.String attachmentName, java.lang.Object attachmentsXML) throws java.lang.Exception
objectStoreName
- ObjectStore Name of the attached item (maybe null).objectId
- Object Id of the attached item.verSerId
- Version Series Id of the attached item (if appropriate object type).objectType
- String type of the selected object (document, folder, search).position
- String index into the displayed list of attachment items.unassign
- Boolean to indicate whether to completely remove the item of just change it to unassigned.attachmentName
- String attachment name.attachmentsXML
- Holds the cached list of attachment items.
java.lang.Exception
- If there are problems retrieving data.public void removeItemFromAttachmentXML(java.lang.String objectStoreName, java.lang.String objectId, java.lang.String verSerId, java.lang.String objectType, java.lang.String position, boolean unassign, java.lang.String attachmentName, org.w3c.dom.Document stepAttachmentsXML) throws java.lang.Exception
objectStoreName
- ObjectStore Name of the attached item (maybe null).objectId
- Object Id of the attached item.verSerId
- Version Series Id of the attached item (if appropriate object type).objectType
- String type of the selected object (document, folder, search).position
- String index into the displayed list of attachment items.unassign
- Boolean to indicate whether to completely remove the item of just change it to unassigned.attachmentName
- String attachment name.stepAttachmentsXML
- Holds the cached list of attachment items.
java.lang.Exception
- If there are problems retrieving data.public void updateAttachmentItemXML(java.lang.String objectStoreName, java.lang.String verSerId, java.lang.String objectId, java.lang.String objectType, java.lang.Object attachmentsXML) throws java.lang.Exception
objectStoreName
- ObjectStore Name of the attached item.verSerId
- Version Series Id of the attached item (if appropriate object type).objectId
- Object Id of the attached item.objectType
- String type of the selected object (document, folder, search).attachmentsXML
- Holds the cached list of attachment items.
java.lang.Exception
- If there are problems retrieving data.public void updateItemInAttachmentXML(java.lang.String objectStoreName, java.lang.String verSerId, java.lang.String objectId, java.lang.String objectType, java.lang.String attachmentName, org.w3c.dom.Document stepAttachmentsXML) throws java.lang.Exception
objectStoreName
- ObjectStore Name of the attached item.verSerId
- Version Series Id of the attached item (if appropriate object type).objectId
- Object Id of the attached item.objectType
- String type of the selected object (document, folder, search).stepAttachmentsXML
- Holds the cached list of attachment items.attachmentName
- - name of attachment to update
java.lang.Exception
- If there are problems retrieving data.public void updateItemsInAttachment(org.w3c.dom.Document stepAttachmentsXML, java.lang.String attachmentName) throws java.lang.Exception
stepAttachmentsXML
- Holds the cached list of attachments.attachmentName
- String holding the specified attachment name
java.lang.Exception
- If there are problems retrieving data.public boolean doCreateAttachments(java.lang.String attachmentName, java.lang.Object attachmentsXML) throws java.lang.Exception
attachmentName
- String holding attachment name.attachmentsXML
- Dom document holding attachments list as XML.
java.lang.Exception
- Thrown when there are errors.public boolean doCreateAttachmentItems(java.lang.String attachmentName, org.w3c.dom.Document stepAttachmentsXML) throws java.lang.Exception
attachmentName
- String holding attachment name.stepAttachmentsXML
- Document holding all step attachments and attachment items as XML
java.lang.Exception
- Thrown when there are errors.public void doProcessSubscriptions(org.w3c.dom.Document domSubscriptionXML, java.lang.String objectStoreName, java.lang.String objectId, java.lang.String versionSeriesId, int objectType, java.util.List policyProcessors) throws java.lang.Exception
domSubscriptionXML
- Document holding the workflow subscrition XML in the Content Engine namespace.objectStoreName
- String holding the objectstore name of the source document.objectId
- String holding the object id of the source document.versionSeriesId
- String holding the version series id of the source document.objectType
- Integer holding the object type.policyProcessors
- List holding form processors information loaded from configuration file
java.lang.Exception
- If there are problems retrieving data.public void doProcessSubscriptions(org.w3c.dom.Document domSubscriptionXML, java.lang.String objectStoreName, java.lang.String objectId, java.lang.String versionSeriesId, int objectType) throws java.lang.Exception
domSubscriptionXML
- Document holding the workflow subscrition XML in the Content Engine namespace.objectStoreName
- String holding the objectstore name of the source document.objectId
- String holding the object id of the source document.versionSeriesId
- String holding the version series id of the source document.objectType
- Integer holding the object type.
java.lang.Exception
- If there are problems retrieving data.public java.lang.String getNodeValue(org.w3c.dom.Node current, java.lang.String xPathExpression, org.w3c.dom.Node namespace) throws java.lang.Exception
current
- Node to look under.xPathExpression
- String hold the xpath expression to use to retrieve the node.namespace
- Node holding the namespace node for the XML document.
java.lang.Exception
- If there are problems retrieving data.public java.lang.String addProcessorInformation(org.w3c.dom.Document domObjectXML, org.w3c.dom.Node nodeObject, java.util.List policyProcessors) throws java.lang.Exception
domObjectXML
- Document holding the XML.nodeObject
- Node holding the object to which to add the processor information.policyProcessors
- List holding Form processor information loaded from configuration file.
java.lang.Exception
- If there are problems retrieving data.public java.lang.String addProcessorInformation(org.w3c.dom.Document domObjectXML, org.w3c.dom.Node nodeObject, org.w3c.dom.Node nodeWCMNamespace, java.util.List policyProcessors) throws java.lang.Exception
domObjectXML
- Document holding the XML.nodeObject
- Node holding the object to which to add the processor information.nodeWCMNamespace
- Node holding the namespace node for the XML document.policyProcessors
- List holding Form processor information loaded from configuration file.
java.lang.Exception
- If there are problems retrieving data.public java.lang.String addProcessorInformation(org.w3c.dom.Document domObjectXML, org.w3c.dom.Node nodeObject, org.w3c.dom.Node nodeWCMNamespace) throws java.lang.Exception
domObjectXML
- Document holding the XML.nodeObject
- Node holding the object to which to add the processor information.nodeWCMNamespace
- Node holding the namespace node for the XML document.
java.lang.Exception
- If there are problems retrieving data.public boolean doProcessPropertyMap(org.w3c.dom.Document domStepElementXML, java.lang.String propertyMap, java.lang.String attachmentId) throws java.lang.Exception
domStepElementXML
- Document holding step element xml.propertyMap
- String holding the data field-to-property mapping.attachmentId
- String holding the main attachment identity.
java.lang.Exception
- If there are problems retrieving data.public void setQueryProperties(java.lang.String[] properties) throws java.lang.Exception
properties
- String[] of property names required for displaying the item in the list view.
java.lang.Exception
- If there are problems retrieving data.public java.lang.String getAttachmentName(java.lang.String objectStoreName, java.lang.String id, java.lang.String type) throws java.lang.Exception
objectStoreName
- Object Store name of initiating attachment object.id
- Object id of initiating attachment object.type
- Object type of initiating attachment object.
java.lang.Exception
- if there were errors retrieving the Attachment name.public org.w3c.dom.Document getObjectPropertiesXML(java.lang.String objectStoreName, java.lang.String objectId, java.lang.String verSerId, int objectType) throws java.lang.Exception
objectStoreName
- ObjectStore Name of item to add.objectId
- Object Id of item to add (may be null).verSerId
- Version Series Id of item to add.objectType
- Object type of item to add.
java.lang.Exception
- Thrown when there are errors.public void setNameProperties(java.lang.String documentNameProperty, java.lang.String folderNameProperty, java.lang.String customObjectNameProperty)
documentNameProperty
- String holding symbolic property name for the Document name property.folderNameProperty
- String holding symbolic property name for the Folder name property.customObjectNameProperty
- String holding symbolic property name for the Custom Object name property.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |