|
||||||||||
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.base.WcmDpModule
com.filenet.wcm.toolkit.server.dp.WcmEProcessDataProvider
Handles data provided from the eProcess Java API.
Field Summary | |
static int |
ENTRY_PROCESSOR
Defines the launch step processor mode for the entry template workflow . |
static int |
GROUPS
Defines the participant retrieval behavior for only groups. |
static int |
LAUNCH_PROCESSOR
Defines the launch step processor mode. |
static java.lang.String |
NO_DATE_VALUE
Defines a long constant being used for generating an empty date value. |
static int |
QUEUE_INFORMATION
Defines the queue information mode. |
static java.lang.String |
QUEUE_TYPE_CENTRIC
Defines the queue type user centric. |
static java.lang.String |
QUEUE_TYPE_PROCESS
Defines the queue type process. |
static java.lang.String |
QUEUE_TYPE_SYSTEM
Defines the queue type system |
static int |
SEARCH_TYPE_CONTAINS
Defines the user or group search type contains. |
static int |
SEARCH_TYPE_CUSTOM
Defines the user or group search type custom. |
static int |
SEARCH_TYPE_PREFIX_MATCH
Defines the user or group search type prefix match. |
static int |
SEARCH_TYPE_SUFFIX_MATCH
Defines the user or group search type suffix match. |
static int |
SORT_TYPE_ASCENDING
Defines the user or group sort type ascending. |
static int |
SORT_TYPE_DESCENDING
Defines the user or group sort type descending. |
static int |
SORT_TYPE_NONE
Defines the user or group sort type none. |
static java.lang.String |
STATE_CLEAN
Defines clean state specified for data field |
static java.lang.String |
STATE_MARKED_REMOVE
Defines marked removed state specified for data field |
static java.lang.String |
STATE_MODIFIED
Defines modified state specified for data field |
static java.lang.String |
STATE_NONE
Defines no state specified for data field |
static java.lang.String |
STATE_NOT_VALID
Defines not valid (and modified) state specified for data field |
static int |
STEP_PROCESSOR
Defines the step processor mode. |
static java.lang.String |
SYSTEMMAP_MALFUNCTION
Defines the Malfunction system map name contained in the workflow definition. |
static java.lang.String |
SYSTEMMAP_QUEUE_ASSERTION
Defines the QueueAssertionViolation system map name contained in the workflow definition. |
static java.lang.String |
SYSTEMMAP_RECOVERY
Defines the Recovery system map name contained in the workflow definition. |
static java.lang.String |
SYSTEMMAP_TERMINATE
Defines the Terminate system map name contained in the workflow definition. |
static java.lang.String |
SYSTEMMAP_TRACKER
Defines the Tracker system map name contained in the workflow definition. |
static java.lang.String |
SYSTEMMAP_WORKFLOW
Defines the Workflow system map name contained in the workflow definition. |
static java.lang.String |
TIME_MASK_CANONICAL
Defines the time mask used for date data fields |
static java.lang.String |
TYPE
Defines the data provider type |
static int |
USERS
Defines the participant retrieval behavior for only users. |
static int |
USERSGROUPS
Defines the participant retrieval behavior for users and groups together. |
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmDpModule |
cache |
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule |
locale, NAME_DELIMITER |
Constructor Summary | |
WcmEProcessDataProvider()
|
Method Summary | |
void |
addAttachmentToArray(java.lang.String name,
java.lang.String objectStore,
java.lang.String objectId,
java.lang.String verSerId,
java.lang.String type)
Adds an attachment to the VWAttachments array. |
boolean |
addParameterValues(org.w3c.dom.Document xmlDoc,
java.lang.String paramName,
java.lang.String[] values)
Append parameter values in XML document. |
boolean |
addWorkflowGroupValues(org.w3c.dom.Document xmlDoc,
java.lang.String paramName,
ParticipantRef[] values)
Append workflow group parameter values in XML document. |
void |
cleanup()
Called by WcmController after persist(), when it's about to go to another JSP page. |
void |
clearStepElementState()
Clear the data in the step element state class currently used by the data provider. |
void |
createAttachmentArray()
Creates a array list to hold the attachment list for a particular StepElement parameter. |
org.w3c.dom.Element |
createChildElement(org.w3c.dom.Document rootDocument,
org.w3c.dom.Element parentElement,
java.lang.String tagName)
Create a child element |
org.w3c.dom.Element |
createChildElement(org.w3c.dom.Document rootDocument,
org.w3c.dom.Element parentElement,
java.lang.String tagName,
java.lang.String value)
Create a child element with a value |
void |
deleteParameterValue(org.w3c.dom.Document xmlDoc,
java.lang.String paramName,
int index)
Deletes parameter value specified by index. |
void |
deleteParameterValues(org.w3c.dom.Document xmlDoc,
java.lang.String paramName,
java.lang.String[] values)
Deletes parameter values from XML document. |
java.lang.Object |
doCreateWorkflow(java.lang.String workflowIdentifier,
java.lang.String subject,
java.lang.String attachmentId)
Launch a workflow from the currently transferred workflow definition. |
boolean |
doEvaluateExpression(java.lang.String subscriptionName,
java.lang.String expression,
java.lang.String objectStoreId,
java.lang.String objectId,
java.lang.String verSerId,
int objectType)
Deprecated. Use the doEvaluateSubscriptionExpression method to evaluate expressions. |
boolean |
doEvaluateSubscriptionExpression(java.lang.String subscriptionName,
java.lang.String workflowExpression,
java.lang.String eventExpression,
java.lang.String objectStoreId,
java.lang.String objectId,
int objectType)
Evaluates the expression of the workflow subscription. |
void |
domToString(org.w3c.dom.Document document)
Convert DOM tree to string. |
void |
doStepElementAbort()
Unlocks a work item associated with this step without updating the fields on the work item. |
void |
doStepElementDispatch()
Completes this step by moving to the next workflow step. |
void |
doStepElementMoveToInbox()
Moves work item to the current user inbox. |
void |
doStepElementReassign(java.lang.String participant,
boolean delegateFlag)
Changes the participant responsible for processing the current step. |
void |
doStepElementReassign(java.lang.String domainId,
java.lang.String participant,
boolean delegateFlag)
Changes the participant responsible for processing the current step. |
void |
doStepElementReturn()
Returns the work item to the queue from which a user originally reassigned or delegated the work item. |
void |
doStepElementSave(boolean unlock)
Saves the work item associated with this step element. |
java.lang.String[] |
fetchMapNames(java.lang.String queueName,
java.lang.String wobNum,
boolean refresh)
Fetches map names for current step element. |
java.lang.String[] |
fetchParticipants(int includeType,
boolean refresh)
Fetches user and group names. |
filenet.vw.api.VWSecurityDomain[] |
fetchSecurityDomains()
Fetches for the security domain list. |
java.lang.String[] |
fetchUserQueueNames(boolean refresh)
Fetches user queue names |
java.lang.String[] |
fetchWorkflowNames(boolean refresh)
Fetches work class names of transfered workflows. |
protected static java.lang.String |
fieldDateToUTCString(java.util.Date theDate)
Get a Date in a String formatted as a UTC ISO String. |
protected static java.lang.String |
fieldModeToString(int modeType)
Returns a string which is the ascii representation of the fields mode type |
protected static java.lang.String |
fieldTypeToString(int fieldType)
Returns a string which is the ascii representation of the field type. |
filenet.vw.api.VWSecurityList |
findGroups(java.lang.String searchPattern,
int searchType,
int sortType,
int maxBufferSize)
Deprecated. |
filenet.vw.api.VWParticipantList |
findGroups(java.lang.String domainId,
java.lang.String searchPattern,
int searchType,
int sortType,
int maxBufferSize)
Finds groups. |
filenet.vw.api.VWSecurityList |
findUsers(java.lang.String searchPattern,
int searchType,
int sortType,
int maxBufferSize)
Deprecated. |
filenet.vw.api.VWParticipantList |
findUsers(java.lang.String domainId,
java.lang.String searchPattern,
int searchType,
int sortType,
int maxBufferSize)
Finds users. |
java.lang.Object |
getClassProperty(java.lang.String key)
Get a key-value in the data store. |
java.lang.String |
getDefaultSecurityDomain()
Returns the name of the Default Security Domain. |
int |
getIsolatedRegion()
Gets the isolated region number for the current session. |
java.lang.Object |
getLaunchedWorkflows(boolean containsMilestones,
boolean refresh)
Get the user-launched workflows by performing a "RosterQuery" against the PE. |
java.lang.Object |
getLaunchedWorkflowsEx(boolean containsMilestones,
boolean refresh)
Get the user-launched workflows. |
java.lang.Object |
getLaunchProcessorInfo(boolean refresh)
Retrieves a collection of Launch Processor Info as XML. |
java.lang.Object |
getLaunchProcessorInfo(java.lang.String workflowVersion,
java.lang.String objectStoreId,
java.lang.String objectStoreName,
java.lang.String objectId,
java.lang.String verSerId,
boolean refresh)
Retrieves the Launch Processor Info as XML. |
java.lang.Object |
getMilestones(int workSpaceId,
int workClassId,
java.lang.String workflowNumber,
int level,
boolean lastOnly,
boolean reachedOnly)
Retrieves the Milestones as XML. |
java.lang.Object |
getMilestones(java.lang.String queueName,
java.lang.String wobNum,
int level,
boolean lastOnly,
boolean reachedOnly,
boolean refresh)
Retrieves the Milestones as XML. |
org.w3c.dom.Node |
getParameterNode(org.w3c.dom.Document xmlDoc,
java.lang.String paramName)
Get step element parameter node from XML document. |
org.w3c.dom.Node |
getParameterNodeByAuthoredName(org.w3c.dom.Document xmlDoc,
java.lang.String paramAuthoredName)
Get step element parameter node from XML document. |
java.util.ArrayList |
getParametersList(org.w3c.dom.Document xmlDoc)
Get step element parameters list from XML document. |
java.lang.String |
getParameterState(org.w3c.dom.Document xmlDoc,
java.lang.String paramName)
Get parameter state value. |
java.lang.String[] |
getParameterValues(org.w3c.dom.Document xmlDoc,
java.lang.String paramName)
Get parameter values from XML document. |
java.lang.String[] |
getParameterValues(org.w3c.dom.Node parameter)
Get parameter values from Parameter Node. |
java.lang.String[] |
getParameterValuesByAuthoredName(org.w3c.dom.Document xmlDoc,
java.lang.String paramAuthoredName)
Get parameter values from XML document. |
java.lang.String |
getParameterValueState(org.w3c.dom.Document xmlDoc,
java.lang.String paramName,
int index)
Get the parameter's status from the Value element. |
ParticipantRef[] |
getParticipants(org.w3c.dom.Document xmlDoc,
java.lang.String paramName)
Get the participant parameter values from XML document. |
java.lang.Object |
getParticipants(int includeType,
boolean refresh)
Gets participants XML document object. |
java.awt.Dimension |
getProcessAdministratorDimension()
Get the Height/Width settings stored on the Process Engine for the Process Administrator applet. |
java.awt.Dimension |
getProcessConfigurationConsoleDimension()
Get the Height/Width settings stored on the Process Engine for the Process Configuration Console applet. |
java.awt.Dimension |
getProcessDesignerDimension()
Get the Height/Width settings stored on the Process Engine for the Process Designer applet. |
java.lang.Object |
getProcessorTemplates(int type,
boolean refresh)
Retrieve the specified processor types from the process api and xml. |
java.awt.Dimension |
getProcessSimulationConsoleDimension()
Get the Height/Width settings stored on the Process Engine for the Process Simulation Console applet. |
java.awt.Dimension |
getProcessSimulationDesignerDimension()
Get the Height/Width settings stored on the Process Engine for the Process Simulation Designer applet. |
java.lang.Object |
getPublicQueues(boolean refresh)
Retrieves a collection of Public Queues as XML. |
java.lang.String |
getQueueAuthoredName(java.lang.String queueName)
Gets the authored name for the queue. |
java.lang.Object |
getQueueElements(java.lang.String queueName,
java.lang.String queueType,
int maxCount,
java.lang.String[] dataFields,
boolean refresh)
Retrieves a collection of Queue Elements as XML. |
java.lang.Object |
getQueueElements(java.lang.String queueName,
java.lang.String queueType,
java.lang.String indexName,
java.lang.String filter,
java.lang.Object[] substitutionVars,
int maxCount,
java.lang.String[] dataFields,
boolean refresh)
Retrieves a collection of Queue Elements as XML. |
java.lang.Object |
getQueueElements(java.lang.String queueName,
java.lang.String queueType,
java.lang.String indexName,
java.lang.String filter,
java.lang.Object[] substitutionVars,
int maxCount,
java.lang.String[] dataFields,
boolean refresh,
java.lang.String stepName,
java.lang.String operator)
Retrieves a collection of Queue Elements as XML. |
int |
getQueueElementsCount()
Retrieves the total count of items in the current queue query. |
filenet.vw.api.VWExposedFieldDefinition[] |
getQueueFieldDefinitions(java.lang.String queueName)
Retrieves the FieldDefinitions associated with a given queue. |
java.lang.String |
getQueueLocalizedName(java.lang.String authoredQueueName)
Gets the localized name for the specified queue. |
java.lang.Object |
getStepElement(boolean refresh)
Gets the step element XML document object. |
java.lang.Object |
getStepElement(java.lang.String queueName,
java.lang.String wobNum,
boolean refresh)
Gets the step element XML document object. |
java.lang.Object |
getStepElement(java.lang.String queueName,
java.lang.String wobNum,
boolean refresh,
boolean lockItem)
Gets the step element XML document object. |
java.lang.String |
getStepElementAttribute(org.w3c.dom.Document xmlDoc,
java.lang.String attributeName)
Get the step element attribute value from XML document. |
java.lang.String |
getStepElementMapName(java.lang.String queueName,
java.lang.String wobNum)
Get the step elements current map name. |
org.w3c.dom.Node |
getStepElementNode(org.w3c.dom.Document xmlDoc)
Get the XML step element node from the XML document. |
WcmStepElementState |
getStepElementState()
Get the step element state class instance currently being used by the data provider. |
java.lang.Object |
getStepHistory(java.lang.String queueName,
java.lang.String wobNum,
java.lang.String mapName,
boolean refresh)
Gets the step element history information. |
java.lang.Object |
getStepProcessorInfo(boolean refresh)
Retrieves a collection of Step Processor Info as XML. |
java.awt.Dimension |
getTaskTrackerDimension()
Get the Height/Width settings stored on the Process Engine for the Task Tracker applet. |
int |
getTotalQueueElementsCount(java.lang.String queueName)
Retrieves the actual number of items in the specified queue query This is value is fetched each time and is not affected by any current filtering that might be taking place with the queue that's stored in the KEY_QUEUE_QUERY class variable. |
java.lang.Object |
getUserQueues(boolean refresh)
Retrieves a collection of User Queues as XML. |
void |
getVWDataFieldXML(filenet.vw.api.VWDataField dataField,
org.w3c.dom.Document queryRoot,
org.w3c.dom.Element fields)
Appends a description of this object's properties, formatted as an XML string, to the specified input buffer. |
void |
getVWDataFieldXML(filenet.vw.api.VWDataField dataField,
java.lang.StringBuffer theBuffer)
Appends a description of this object's properties, formatted as an XML string, to the specified input buffer. |
filenet.vw.api.VWQueue |
getVWQueue(java.lang.String name)
Get the queue by name. |
java.util.Locale |
getVWSessionServerLocale()
Gets the Locale of the PE Server |
java.util.Locale[] |
getVWSessionSupportedLocales()
Retrieves the locales that the PE Server supports for multilingual application funstionality |
filenet.vw.api.VWUserInfo |
getVWUserInfo()
Gets the currently logged-on user's info from the PE server |
java.lang.String |
getWorkflowDefinition(java.lang.String objectStoreName,
java.lang.String objectId,
boolean refresh)
Get the specified workflow definition and cach it locally in the data provider. |
filenet.vw.api.VWWorkflowDefinition |
getWorkflowDefinitionFromProcessEngine(java.lang.String vwVersion,
boolean refresh)
Get the specified workflow definition and cach it locally in the data provider. |
void |
initialize()
Called by WcmController when the module is registered, and has access to the data store. |
void |
persist()
Called by WcmController before cleanup(), when it's about to go to another Java™Server Pages (JSP) page. |
void |
resetClassProperties(boolean clearQueueData)
Reset data provider class properties. |
void |
resetClassProperties(boolean clearQueueData,
boolean clearStepData)
Reset data provider class properties. |
void |
setClassProperty(java.lang.String key,
java.lang.Object value)
Set a key-value in the data store. |
void |
setParameterState(org.w3c.dom.Document xmlDoc,
java.lang.String paramName,
java.lang.String state)
Set parameter state status. |
boolean |
setParameterValues(org.w3c.dom.Document xmlDoc,
org.w3c.dom.Node parameter,
java.lang.String paramName,
java.lang.String[] values)
Set parameter values in XML document. |
boolean |
setParameterValues(org.w3c.dom.Document xmlDoc,
java.lang.String paramName,
java.lang.String[] values)
Set parameter values in XML document. |
void |
setParameterValueState(org.w3c.dom.Document xmlDoc,
java.lang.String paramName,
int index,
java.lang.String state)
Set parameter state status. |
boolean |
setParameterValuesUsingAuthoredName(org.w3c.dom.Document xmlDoc,
java.lang.String paramAuthoredName,
java.lang.String[] values)
Set parameter values in XML document. |
boolean |
setSelectedResponse(org.w3c.dom.Document xmlDoc,
java.lang.String response)
Set selected response in XML document. |
void |
setStepElementAttachments(boolean doSave)
Set the modified attachment information into the StepElement parameters and save to the server. |
void |
setStepElementAttachments(org.w3c.dom.Document stepAttachmentsXML,
boolean doSave)
Set the modified attachment information into the StepElement parameters and save to the server. |
void |
setStepElementGeneralInfo(int processorType)
Sets step element general info on workflow server. |
void |
setStepElementParameter(org.w3c.dom.Document xmlDoc,
org.w3c.dom.Element theParameter)
Set step element parameter value on workflow server. |
void |
setStepElementParameter(org.w3c.dom.Document xmlDoc,
java.lang.String parameterName)
Set step element parameter value on workflow server. |
void |
setStepElementParameterByAuthoredName(org.w3c.dom.Document xmlDoc,
java.lang.String authoredParameterName)
Set step element parameter value on workflow server. |
void |
setStepElementParameters(java.lang.String paramType)
Set step element parameter values on workflow server |
void |
setVWSessionLocale(java.util.Locale locale)
Sets the client locale setting within the VWSession |
boolean |
setWorkflowGroupValues(org.w3c.dom.Document xmlDoc,
java.lang.String paramName,
ParticipantRef[] values)
Set the workflow group parameter values in XML document. |
java.lang.String |
transferWorkflowDefinition(java.lang.String workflowName,
java.lang.String objectStoreName,
java.lang.String objectId,
java.lang.String verSerId)
Transfer the existing workflow definition to the workflow server. |
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmDpModule |
type |
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmModule |
addChild, addChild, addChild, debugTrace, getClassProperty, getClassPropertyKeys, getConfiguration, getController, getDataStore, getModuleProperty, getModuleProperty, getModuleProperty, getModuleProperty, getModulePropertyKeys, getName, getParent, getWindowProperty, getWindowProperty, queryDataProvider, 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, getDataStore, getModuleProperty, getName, getParent, queryDataProvider, setController, setModuleProperty, setName, setParent |
Field Detail |
public static final java.lang.String TYPE
public static final int STEP_PROCESSOR
public static final int LAUNCH_PROCESSOR
public static final int QUEUE_INFORMATION
public static final int ENTRY_PROCESSOR
public static final java.lang.String QUEUE_TYPE_PROCESS
public static final java.lang.String QUEUE_TYPE_CENTRIC
public static final java.lang.String QUEUE_TYPE_SYSTEM
public static final java.lang.String TIME_MASK_CANONICAL
public static final int USERS
public static final int GROUPS
public static final int USERSGROUPS
public static final java.lang.String STATE_NONE
public static final java.lang.String STATE_CLEAN
public static final java.lang.String STATE_MODIFIED
public static final java.lang.String STATE_NOT_VALID
public static final java.lang.String STATE_MARKED_REMOVE
public static final java.lang.String SYSTEMMAP_WORKFLOW
public static final java.lang.String SYSTEMMAP_TERMINATE
public static final java.lang.String SYSTEMMAP_MALFUNCTION
public static final java.lang.String SYSTEMMAP_QUEUE_ASSERTION
public static final java.lang.String SYSTEMMAP_RECOVERY
public static final java.lang.String SYSTEMMAP_TRACKER
public static final int SEARCH_TYPE_CUSTOM
public static final int SEARCH_TYPE_PREFIX_MATCH
public static final int SEARCH_TYPE_SUFFIX_MATCH
public static final int SEARCH_TYPE_CONTAINS
public static final int SORT_TYPE_NONE
public static final int SORT_TYPE_ASCENDING
public static final int SORT_TYPE_DESCENDING
public static final java.lang.String NO_DATE_VALUE
Constructor Detail |
public WcmEProcessDataProvider()
Method Detail |
public void initialize() throws java.lang.Exception
WcmModuleInterface
initialize
in interface WcmModuleInterface
initialize
in class WcmModule
java.lang.Exception
public WcmStepElementState getStepElementState() throws java.lang.Exception
java.lang.Exception
- if there were errors retrieving datapublic void clearStepElementState() throws java.lang.Exception
java.lang.Exception
- if there were errors retrieving datapublic void persist() throws java.lang.Exception
WcmModuleInterface
persist
in interface WcmModuleInterface
persist
in class WcmModule
java.lang.Exception
public void cleanup() throws java.lang.Exception
WcmModuleInterface
cleanup
in interface WcmModuleInterface
cleanup
in class WcmModule
java.lang.Exception
public void setClassProperty(java.lang.String key, java.lang.Object value) throws java.lang.Exception
setClassProperty
in class WcmModule
key
- The key name to use.value
- The value to set. null is valid, and clears the key.
java.lang.Exception
- If there are problems retrieving data.Calls setClassProperty(key, value, false)
public java.lang.Object getClassProperty(java.lang.String key) throws java.lang.Exception
getClassProperty
in class WcmModule
key
- The key name to use.
java.lang.Exception
- If there are problems retrieving data.public void resetClassProperties(boolean clearQueueData) throws java.lang.Exception
clearQueueData
- boolean, True specifies that the Queue Element list data being held in the class properties is also cleared.
False clears only the Step Element data.
java.lang.Exception
- If there are problems retrieving data.public void resetClassProperties(boolean clearQueueData, boolean clearStepData) throws java.lang.Exception
clearQueueData
- boolean, True specifies that the Queue Element list data being held in the class properties is also cleared.
False does not clear Queue data.clearStepData
- boolean, True specifies that the Step data being held in the class properties is also cleared.
False does not clear Step data.
java.lang.Exception
- If there are problems retrieving data.public void doStepElementAbort() throws java.lang.Exception
java.lang.Exception
- If there are problems retrieving data.public void doStepElementDispatch() throws java.lang.Exception
java.lang.Exception
- If there are problems retrieving data.public void doStepElementReassign(java.lang.String participant, boolean delegateFlag) throws java.lang.Exception
participant
- The name of the new participant being assigned to process the step.delegateFlag
- Specify true if you delegate the assignment and plan to review the completed assignment; otherwise specify false.
java.lang.Exception
- If there are problems retrieving data.public void doStepElementReassign(java.lang.String domainId, java.lang.String participant, boolean delegateFlag) throws java.lang.Exception
domainId
- String the domain id of the participantparticipant
- The name of the new participant being assigned to process the step.delegateFlag
- Specify true if you delegate the assignment and plan to review the completed assignment; otherwise specify false.
java.lang.Exception
- If there are problems retrieving data.public void doStepElementSave(boolean unlock) throws java.lang.Exception
unlock
- Specify true to save and unlock the work item; specify false to maintain the current lock and save the work item.
java.lang.Exception
- If there are problems retrieving data.public void doStepElementReturn() throws java.lang.Exception
java.lang.Exception
- If there are problems retrieving data.public void doStepElementMoveToInbox() throws java.lang.Exception
java.lang.Exception
- If there are problems retrieving data.public java.lang.Object doCreateWorkflow(java.lang.String workflowIdentifier, java.lang.String subject, java.lang.String attachmentId) throws java.lang.Exception
workflowIdentifier
- Visual WorkFlo version stringsubject
- Workflow subject from linkerattachmentId
- Main workflow attachment
java.lang.Exception
- If there are problems retrieving data.public java.lang.Object getUserQueues(boolean refresh) throws java.lang.Exception
The refresh parameter works as follows: True causes the data to be retrieved from the application server; False causes the data to be retrieved from the web server cache.
refresh
- Boolean flag that specifies the data retrival location.
java.lang.Exception
- If there are problems retreving collection data.public java.lang.String[] fetchUserQueueNames(boolean refresh) throws java.lang.Exception
refresh
- True to retrieve map names from VWSession; otherwise, fetch the in-memory copy
java.lang.Exception
- If there are problems retrieving data.public filenet.vw.api.VWQueue getVWQueue(java.lang.String name) throws java.lang.Exception
name
-
java.lang.Exception
public java.lang.Object getPublicQueues(boolean refresh) throws java.lang.Exception
The refresh parameter works as follows: True causes the data to be retrieved from the application server; False causes the data to be retrieved from the web server cache.
refresh
- Boolean flag that specifies the data retrival location.
java.lang.Exception
- If there are problems retreving collection data.public java.lang.Object getQueueElements(java.lang.String queueName, java.lang.String queueType, int maxCount, java.lang.String[] dataFields, boolean refresh) throws java.lang.Exception
The refresh parameter works as follows: True causes the data to be retrieved from the application server; False causes the data to be retrieved from the web server cache.
queueName
- String holding the queue name to retrive elements from.queueType
- String holding the queue type, User or Process.maxCount
- Int holding how many elements must be retrieved into the element cache.dataFields
- String array holding the list of data fields to be returned as part of the queue element data.refresh
- Boolean flag that specifies the data retrival location.
java.lang.Exception
- If there are problems retreving collection data.public java.lang.Object getQueueElements(java.lang.String queueName, java.lang.String queueType, java.lang.String indexName, java.lang.String filter, java.lang.Object[] substitutionVars, int maxCount, java.lang.String[] dataFields, boolean refresh) throws java.lang.Exception
The refresh parameter works as follows: True causes the data to be retrieved from the application server; False causes the data to be retrieved from the web server cache.
queueName
- String holding the queue name to retrive elements from.queueType
- String holding the queue type, User or Process.indexName
- String holding the index names used for sorting the query result.filter
- String Containins a SQL statement that specifies a filter conditions(used with values input to
the substitutionVars parameter).substitutionVars
- An array of objects that contain the values to substitute for the variable names
to the right of the colons in the SQL statement you passed to the filter parameter.maxCount
- Int holding how many elements must be retrieved into the element cache.dataFields
- String array holding the list of data fields to be returned as part of the queue element data.refresh
- Boolean flag that specifies the data retrival location.
java.lang.Exception
- If there are problems retreving collection data.public java.lang.Object getQueueElements(java.lang.String queueName, java.lang.String queueType, java.lang.String indexName, java.lang.String filter, java.lang.Object[] substitutionVars, int maxCount, java.lang.String[] dataFields, boolean refresh, java.lang.String stepName, java.lang.String operator) throws java.lang.Exception
The refresh parameter works as follows: True causes the data to be retrieved from the application server; False causes the data to be retrieved from the web server cache.
queueName
- String holding the queue name to retrive elements from.queueType
- String holding the queue type, User or Process.indexName
- String holding the index names used for sorting the query result.filter
- String Containins a SQL statement that specifies a filter conditions(used with values input to
the substitutionVars parameter).substitutionVars
- An array of objects that contain the values to substitute for the variable names
to the right of the colons in the SQL statement you passed to the filter parameter.maxCount
- Int holding how many elements must be retrieved into the element cache.dataFields
- String array holding the list of data fields to be returned as part of the queue element data.refresh
- Boolean flag that specifies the data retrival location.stepName
- String holding the name of the step on which to apply a filteroperator
- String holding the operator used by the stepName filter
java.lang.Exception
- If there are problems retreving collection data.public int getQueueElementsCount() throws java.lang.Exception
java.lang.Exception
- If there are problems retrieving collection data.public int getTotalQueueElementsCount(java.lang.String queueName) throws java.lang.Exception
queueName
- String the name of the queue from which to retrieve an element count
java.lang.Exception
public filenet.vw.api.VWExposedFieldDefinition[] getQueueFieldDefinitions(java.lang.String queueName) throws java.lang.Exception
queueName
- String containing the name of the queue from which to retrieve fields.
java.lang.Exception
- If there are problems retrieving collection data.public void setVWSessionLocale(java.util.Locale locale) throws java.lang.Exception
locale
- - a Locale object, typically the locale set in the user's browser.
java.lang.Exception
- - Exception object returned if there is a problem setting the VW Session localepublic java.lang.String getQueueAuthoredName(java.lang.String queueName) throws java.lang.Exception
queueName
-
java.lang.Exception
public java.lang.String getQueueLocalizedName(java.lang.String authoredQueueName) throws java.lang.Exception
authoredQueueName
-
java.lang.Exception
public java.util.Locale[] getVWSessionSupportedLocales() throws java.lang.Exception
java.lang.Exception
- - Exception object returned if there is a problem retrieving the supported localespublic java.util.Locale getVWSessionServerLocale() throws java.lang.Exception
java.lang.Exception
- - Exception object returned if there is a problem retreiving the PE server localepublic filenet.vw.api.VWUserInfo getVWUserInfo() throws java.lang.Exception
java.lang.Exception
public java.lang.Object getStepProcessorInfo(boolean refresh) throws java.lang.Exception
The refresh parameter works as follows: True causes the data to be retrieved from the application server; False causes the data to be retrieved from the web server cache.
refresh
- Boolean flag that specifies the data retrieval location.
java.lang.Exception
- If there are problems retrieving collection data.public java.lang.Object getLaunchProcessorInfo(boolean refresh) throws java.lang.Exception
The refresh parameter works as follows: True causes the data to be retrieved from the application server; False causes the data to be retrieved from the web server cache.
refresh
- Boolean flag that specifies the data retrieval location.
java.lang.Exception
- If there are problems retrieving collection data.public java.lang.Object getLaunchProcessorInfo(java.lang.String workflowVersion, java.lang.String objectStoreId, java.lang.String objectStoreName, java.lang.String objectId, java.lang.String verSerId, boolean refresh) throws java.lang.Exception
The refresh parameter works as follows: True causes the data to be retrieved from the application server; False causes the data to be retrieved from the web server cache.
workflowVersion
- String holding workflow compiled version of the workflow definition.objectStoreId
- ObjectStore Id for the Workflow DefinitionobjectStoreName
- ObjectStore Name for the Workflow DefinitionobjectId
- Document Id for the Workflow DefinitionverSerId
- Version Series Id for the Workflow Definitionrefresh
- Boolean flag that specifies the data retrieval location.
java.lang.Exception
- If there are problems retrieving the data.public java.lang.String transferWorkflowDefinition(java.lang.String workflowName, java.lang.String objectStoreName, java.lang.String objectId, java.lang.String verSerId) throws java.lang.Exception
workflowName
- String holding new workflow name, maybe nullobjectStoreName
- ObjectStore Name for the Workflow DefinitionobjectId
- Document Id for the Workflow DefinitionverSerId
- Version Series Id for the Workflow Definition
java.lang.Exception
- If there are problems retrieving collection data.public java.lang.String getWorkflowDefinition(java.lang.String objectStoreName, java.lang.String objectId, boolean refresh) throws java.lang.Exception
objectStoreName
- ObjectStore Name for the Workflow DefinitionobjectId
- Document Id for the Workflow Definitionrefresh
- True to retrieve class names from VWSession; otherwise, fetch the in-memory copy
java.lang.Exception
- If there are problems retrieving collection data.public filenet.vw.api.VWWorkflowDefinition getWorkflowDefinitionFromProcessEngine(java.lang.String vwVersion, boolean refresh) throws java.lang.Exception
vwVersion
- Process Engine identifier for the Workflow Definitionrefresh
- True to retrieve class names from VWSession; otherwise, fetch the in-memory copy
java.lang.Exception
- If there are problems retrieving data.public java.lang.String[] fetchWorkflowNames(boolean refresh) throws java.lang.Exception
refresh
- True to retrieve class names from VWSession; otherwise, fetch the in-memory copy
java.lang.Exception
- If there are problems retrieving data.public boolean doEvaluateExpression(java.lang.String subscriptionName, java.lang.String expression, java.lang.String objectStoreId, java.lang.String objectId, java.lang.String verSerId, int objectType) throws java.lang.Exception
subscriptionName
- String name of the subscription.expression
- String expression.objectStoreId
- ObjectStore Id for the source document.objectId
- Document Id for the source document.verSerId
- Version Series Id for the source document.objectType
- Integer holding the object type.
java.lang.Exception
- If there are problems retrieving collection data.public boolean doEvaluateSubscriptionExpression(java.lang.String subscriptionName, java.lang.String workflowExpression, java.lang.String eventExpression, java.lang.String objectStoreId, java.lang.String objectId, int objectType) throws java.lang.Exception
subscriptionName
- String name of the subscription.workflowExpression
- String The workflow filtering expression.eventExpression
- String The event filtering expression.objectStoreId
- ObjectStore Id for the source document.objectId
- Document Id for the source document.objectType
- Integer holding the object type.
java.lang.Exception
- If there are problems retrieving collection data.public int getIsolatedRegion() throws java.lang.Exception
java.lang.Exception
- If there are problems retrieving the data.public java.lang.Object getMilestones(java.lang.String queueName, java.lang.String wobNum, int level, boolean lastOnly, boolean reachedOnly, boolean refresh) throws java.lang.Exception
The refresh parameter works as follows: True causes the data to be retrieved from the application server; False causes the data to be retrieved from the web server cache.
queueName
- Queue Name.wobNum
- Workflow object number.level
- int holding the milestone level you wish to retrieve.lastOnly
- True limits fetches to the milestone objects with the latest timestamp;
False does not eliminate milestone objects on the basis of timestamp.reachedOnly
- True limits fetches to the reached milestone objects;
False does not limit fetches to the reached milestone objects.refresh
- Boolean flag that specifies the data retrieval location.
java.lang.Exception
- If there are problems retrieving collection data.public java.lang.Object getMilestones(int workSpaceId, int workClassId, java.lang.String workflowNumber, int level, boolean lastOnly, boolean reachedOnly) throws java.lang.Exception
workSpaceId
- Work space IdworkClassId
- Work class IdworkflowNumber
- Workflow numberlevel
- Milestone level to retrievelastOnly
- True limits fetches to the milestone objects with the latest timestamp;
False does not eliminate milestone objects on the basis of timestamp.reachedOnly
- True limits fetches to the reached milestone objects;
False does not limit fetches to the reached milestone objects.
java.lang.Exception
- If there are problems retrieving collection data.public java.lang.Object getStepElement(java.lang.String queueName, java.lang.String wobNum, boolean refresh, boolean lockItem) throws java.lang.Exception
queueName
- Queue NamewobNum
- Workflow object numberrefresh
- True to retrieve step element XML from VWStepElement; otherwise, fetch the in-memory copylockItem
- True, to lock Work Item, False to leav item unlocked
java.lang.Exception
- If there are problems retrieving data.public java.lang.Object getStepElement(java.lang.String queueName, java.lang.String wobNum, boolean refresh) throws java.lang.Exception
queueName
- Queue NamewobNum
- Workflow object numberrefresh
- True to retrieve step element XML from VWStepElement; otherwise, fetch the in-memory copy
java.lang.Exception
- If there are problems retrieving data.public java.lang.Object getStepElement(boolean refresh) throws java.lang.Exception
refresh
- True to retrieve step element XML from VWStepElement; otherwise, fetch the in-memory copy.
java.lang.Exception
- If there are problems retrieving data.public java.lang.Object getStepHistory(java.lang.String queueName, java.lang.String wobNum, java.lang.String mapName, boolean refresh) throws java.lang.Exception
queueName
- Queue Name.wobNum
- Workflow object number.mapName
- Instruction sheet name to use when retrieving step history.refresh
- True to retrieve step history XML; otherwise, fetch the in-memory copy
java.lang.Exception
- If there are problems retrieving data.public java.lang.Object getLaunchedWorkflowsEx(boolean containsMilestones, boolean refresh) throws java.lang.Exception
containsMilestones
- True to get workflows containing milestones; False to get workflows with or without milestones.refresh
- True to retrieve launched workflow XML from API; otherwise, fetch the in-memory copy.
java.lang.Exception
- If there are problems retrieving data.public java.lang.Object getLaunchedWorkflows(boolean containsMilestones, boolean refresh) throws java.lang.Exception
containsMilestones
- True to get workflows containing milestones; False to get workflows with or without milestones.refresh
- True to retrieve launched workflow XML from API; otherwise, fetch the in-memory copy.
java.lang.Exception
- If there are problems retrieving data.public java.lang.String getStepElementMapName(java.lang.String queueName, java.lang.String wobNum) throws java.lang.Exception
queueName
- Queue namewobNum
- Work Object Number
java.lang.Exception
- If there are problems retrieving data.public java.lang.String[] fetchMapNames(java.lang.String queueName, java.lang.String wobNum, boolean refresh) throws java.lang.Exception
queueName
- Queue Name.wobNum
- Workflow object number.refresh
- True to retrieve map names from VWSession; otherwise, fetch the in-memory copy
java.lang.Exception
- If there are problems retrieving data.public filenet.vw.api.VWSecurityDomain[] fetchSecurityDomains() throws java.lang.Exception
java.lang.Exception
- If there are problems retrieving data.public java.lang.String[] fetchParticipants(int includeType, boolean refresh) throws java.lang.Exception
includeType
- int to indicate what type of items to return in the list
0 - users
1 - groups
2 - users and groupsrefresh
- True to retrieve participants from VWSession; otherwise, fetch the in-memory copy
java.lang.Exception
- If there are problems retrieving data.public filenet.vw.api.VWSecurityList findGroups(java.lang.String searchPattern, int searchType, int sortType, int maxBufferSize) throws java.lang.Exception
searchPattern
- String pattern to query for groups.searchType
- int The criteria to search by.sortType
- int The sort type (none, ascending or descending).maxBufferSize
- int The maximum number of users objects to return in the result collection
java.lang.Exception
- If there are problems retrieving data.public filenet.vw.api.VWParticipantList findGroups(java.lang.String domainId, java.lang.String searchPattern, int searchType, int sortType, int maxBufferSize) throws java.lang.Exception
domainId
- Stirng The domainId.searchPattern
- String pattern to query for groups.searchType
- int The criteria to search by.sortType
- int The sort type (none, ascending or descending).maxBufferSize
- int The maximum number of users objects to return in the result collection
java.lang.Exception
- If there are problems retrieving data.public filenet.vw.api.VWSecurityList findUsers(java.lang.String searchPattern, int searchType, int sortType, int maxBufferSize) throws java.lang.Exception
searchPattern
- String pattern to query for users.searchType
- int The criteria to search by.sortType
- int The sort type (none, ascending or descending).maxBufferSize
- int The maximum number of users objects to return in the result collectio
java.lang.Exception
- If there are problems retrieving data.public filenet.vw.api.VWParticipantList findUsers(java.lang.String domainId, java.lang.String searchPattern, int searchType, int sortType, int maxBufferSize) throws java.lang.Exception
domainId
- Stirng The domainId.searchPattern
- String pattern to query for users.searchType
- int The criteria to search by.sortType
- int The sort type (none, ascending or descending).maxBufferSize
- int The maximum number of users objects to return in the result collectio
java.lang.Exception
- If there are problems retrieving data.public java.lang.String getDefaultSecurityDomain() throws java.lang.Exception
java.lang.Exception
public java.lang.Object getParticipants(int includeType, boolean refresh) throws java.lang.Exception
includeType
- int to indicate what type of items to return in the list
0 - users
1 - groups
2 - users and groupsrefresh
- True to retrieve participants from VWSession; otherwise, fetch the in-memory copy
java.lang.Exception
- If there are problems retrieving data.public void setStepElementGeneralInfo(int processorType) throws java.lang.Exception
processorType
- int the type of processor LAUNCH_PROCESSOR or STEP_PROCESSOR
java.lang.Exception
- If there are problems retrieving data.public void setStepElementParameters(java.lang.String paramType) throws java.lang.Exception
paramType
- Specifies what type (alltypes, boolean, int, float, string, time, attachment, participant) of parameters to save
java.lang.Exception
- If there are problems retrieving data.public void setStepElementParameter(org.w3c.dom.Document xmlDoc, java.lang.String parameterName) throws java.lang.Exception
xmlDoc
- Step element XML document object.parameterName
- A string containing the parameter name.
java.lang.Exception
- If there are problems retrieving data.public void setStepElementParameterByAuthoredName(org.w3c.dom.Document xmlDoc, java.lang.String authoredParameterName) throws java.lang.Exception
xmlDoc
- Step element XML document object.authoredParameterName
- A string containing the authored (non-localized) parameter name.
java.lang.Exception
- If there are problems retrieving data.public void setStepElementParameter(org.w3c.dom.Document xmlDoc, org.w3c.dom.Element theParameter) throws java.lang.Exception
xmlDoc
- Step element XML document object.theParameter
- The parameter element node.
java.lang.Exception
- If there are problems retrieving data.public org.w3c.dom.Node getStepElementNode(org.w3c.dom.Document xmlDoc) throws java.lang.Exception
xmlDoc
- document object
java.lang.Exception
- If there are problems retrieving data.public java.lang.String getStepElementAttribute(org.w3c.dom.Document xmlDoc, java.lang.String attributeName) throws java.lang.Exception
xmlDoc
- Document objectattributeName
- Attribute name
java.lang.Exception
- If there are problems retrieving data.public org.w3c.dom.Node getParameterNode(org.w3c.dom.Document xmlDoc, java.lang.String paramName) throws java.lang.Exception
xmlDoc
- Document object.paramName
- Parameter name.
java.lang.Exception
- If there are problems retrieving data.public org.w3c.dom.Node getParameterNodeByAuthoredName(org.w3c.dom.Document xmlDoc, java.lang.String paramAuthoredName) throws java.lang.Exception
xmlDoc
- Document object.paramAuthoredName
- Parameter authored name.
java.lang.Exception
- If there are problems retrieving data.public java.util.ArrayList getParametersList(org.w3c.dom.Document xmlDoc) throws java.lang.Exception
xmlDoc
- Document object.
java.lang.Exception
- If there are problems retrieving data.public java.lang.String[] getParameterValues(org.w3c.dom.Node parameter) throws java.lang.Exception
parameter
- Node holding Parameter.
java.lang.Exception
- If there are problems retrieving data.public java.lang.String[] getParameterValues(org.w3c.dom.Document xmlDoc, java.lang.String paramName) throws java.lang.Exception
xmlDoc
- Document object.paramName
- Parameter name.
java.lang.Exception
- If there are problems retrieving data.public java.lang.String[] getParameterValuesByAuthoredName(org.w3c.dom.Document xmlDoc, java.lang.String paramAuthoredName) throws java.lang.Exception
xmlDoc
- Document object.paramAuthoredName
- Parameter Authored Name.
java.lang.Exception
- If there are problems retrieving data.public ParticipantRef[] getParticipants(org.w3c.dom.Document xmlDoc, java.lang.String paramName) throws java.lang.Exception
xmlDoc
- Document object.paramName
- Parameter name.
java.lang.Exception
- If there are problems retrieving data.public boolean addParameterValues(org.w3c.dom.Document xmlDoc, java.lang.String paramName, java.lang.String[] values) throws java.lang.Exception
xmlDoc
- Document object.paramName
- Parameter name.values
- Parameter values.
java.lang.Exception
- If there are problems retrieving data.public boolean addWorkflowGroupValues(org.w3c.dom.Document xmlDoc, java.lang.String paramName, ParticipantRef[] values) throws java.lang.Exception
xmlDoc
- Document object.paramName
- Parameter name.values
- Parameter values.
java.lang.Exception
- If there are problems retrieving data.public boolean setParameterValues(org.w3c.dom.Document xmlDoc, java.lang.String paramName, java.lang.String[] values) throws java.lang.Exception
xmlDoc
- Document object.paramName
- Parameter name.values
- Parameter value array. If the array is null or empty, removes all values.
java.lang.Exception
- If there are problems retrieving data.public boolean setParameterValuesUsingAuthoredName(org.w3c.dom.Document xmlDoc, java.lang.String paramAuthoredName, java.lang.String[] values) throws java.lang.Exception
xmlDoc
- Document object.paramAuthoredName
- Parameter's authored name.values
- Parameter value array. If the array is null or empty, removes all values.
java.lang.Exception
- If there are problems retrieving data.public boolean setParameterValues(org.w3c.dom.Document xmlDoc, org.w3c.dom.Node parameter, java.lang.String paramName, java.lang.String[] values) throws java.lang.Exception
xmlDoc
- Document object.parameter
- Node holding Parameter.paramName
- Parameter name.values
- Parameter value array. If the array is null or empty, removes all values.
java.lang.Exception
- If there are problems retrieving data.public boolean setWorkflowGroupValues(org.w3c.dom.Document xmlDoc, java.lang.String paramName, ParticipantRef[] values) throws java.lang.Exception
xmlDoc
- Document object.paramName
- Parameter name.values
- Parameter value array. If the array is null or empty, removes all values.
java.lang.Exception
- If there are problems retrieving data.public void deleteParameterValues(org.w3c.dom.Document xmlDoc, java.lang.String paramName, java.lang.String[] values) throws java.lang.Exception
xmlDoc
- Document object.paramName
- Parameter name.values
- Parameter value array.
java.lang.Exception
- If there are problems retrieving data.public void deleteParameterValue(org.w3c.dom.Document xmlDoc, java.lang.String paramName, int index) throws java.lang.Exception
xmlDoc
- Document object.paramName
- Parameter name.index
- Array index (0 based).
java.lang.Exception
- If there are problems retrieving data.public java.lang.String getParameterValueState(org.w3c.dom.Document xmlDoc, java.lang.String paramName, int index) throws java.lang.Exception
xmlDoc
- Document object.paramName
- Parameter name.index
- Array index
java.lang.Exception
- If there are problems retrieving data.public void setParameterValueState(org.w3c.dom.Document xmlDoc, java.lang.String paramName, int index, java.lang.String state) throws java.lang.Exception
xmlDoc
- Document object.paramName
- Parameter name.index
- Array index.state
- String holding the state value to set.
java.lang.Exception
- If there are problems retrieving data.public void setParameterState(org.w3c.dom.Document xmlDoc, java.lang.String paramName, java.lang.String state) throws java.lang.Exception
xmlDoc
- Document object.paramName
- Parameter name.state
- String holding the value to be set.
java.lang.Exception
- If there are problems retrieving data.public java.lang.String getParameterState(org.w3c.dom.Document xmlDoc, java.lang.String paramName) throws java.lang.Exception
xmlDoc
- Document object.paramName
- Parameter name.
java.lang.Exception
- If there are problems retrieving data.public boolean setSelectedResponse(org.w3c.dom.Document xmlDoc, java.lang.String response) throws java.lang.Exception
xmlDoc
- Document objectresponse
- Selected response.
java.lang.Exception
- If there are problems retrieving data.public void setStepElementAttachments(boolean doSave) throws java.lang.Exception
doSave
- Boolean value indicates whether VWStepElement doSave method should be called. True only when in the Step Processor.
java.lang.Exception
- If there are problems retrieving data.public void setStepElementAttachments(org.w3c.dom.Document stepAttachmentsXML, boolean doSave) throws java.lang.Exception
stepAttachmentsXML
- Document object holding the attachments information as XMLdoSave
- Boolean value indicates whether VWStepElement doSave method should be called. True only when in the Step Processor.
java.lang.Exception
- If there are problems retrieving data.public void createAttachmentArray() throws java.lang.Exception
java.lang.Exception
- If there are problems.public void addAttachmentToArray(java.lang.String name, java.lang.String objectStore, java.lang.String objectId, java.lang.String verSerId, java.lang.String type) throws java.lang.Exception
name
- String name of attachment item.objectStore
- String name of objectstore.objectId
- String id of specific object version.verSerId
- String version series id.type
- String type of attachment item.
java.lang.Exception
- If there are problems retrieving data.public void domToString(org.w3c.dom.Document document) throws java.lang.Exception
document
- Document object
java.lang.Exception
- If there are problems retrieving data.public void getVWDataFieldXML(filenet.vw.api.VWDataField dataField, java.lang.StringBuffer theBuffer) throws java.lang.Exception
This description includes Name, Type, IsSystemField Flag, Mode, IsArray Flag, and either field values or string representations of attachments.
Warning: This general list of properties currently contained in the appended string is subject to change without notice.
theBuffer
- A string buffer that this method will append with XML content.
java.lang.Exception
public void getVWDataFieldXML(filenet.vw.api.VWDataField dataField, org.w3c.dom.Document queryRoot, org.w3c.dom.Element fields) throws java.lang.Exception
This description includes Name, Type, IsSystemField Flag, Mode, IsArray Flag, and either field values or string representations of attachments.
Warning: This general list of properties currently contained in the appended string is subject to change without notice.
fields
- Node holding the current fields element to add information to.
java.lang.Exception
public org.w3c.dom.Element createChildElement(org.w3c.dom.Document rootDocument, org.w3c.dom.Element parentElement, java.lang.String tagName)
rootDocument
- Document holding the root of the dom treeparentElement
- Element the parent of the new childtagName
- String the tag name for the new child
public org.w3c.dom.Element createChildElement(org.w3c.dom.Document rootDocument, org.w3c.dom.Element parentElement, java.lang.String tagName, java.lang.String value)
rootDocument
- Document holding the root of the dom treeparentElement
- the parent of the new childtagName
- String the tag name for the new childvalue
- String the value to put into the child Element
public java.awt.Dimension getProcessDesignerDimension() throws java.lang.Exception
java.lang.Exception
public java.awt.Dimension getProcessSimulationConsoleDimension() throws java.lang.Exception
java.lang.Exception
public java.awt.Dimension getProcessSimulationDesignerDimension() throws java.lang.Exception
java.lang.Exception
public java.awt.Dimension getProcessAdministratorDimension() throws java.lang.Exception
java.lang.Exception
public java.awt.Dimension getProcessConfigurationConsoleDimension() throws java.lang.Exception
java.lang.Exception
public java.awt.Dimension getTaskTrackerDimension() throws java.lang.Exception
java.lang.Exception
protected static java.lang.String fieldDateToUTCString(java.util.Date theDate)
protected static java.lang.String fieldTypeToString(int fieldType) throws java.lang.Exception
fieldType
- an int representing a valid field type.
java.lang.Exception
- if the fieldType value is not a valid field type.protected static java.lang.String fieldModeToString(int modeType) throws java.lang.Exception
java.lang.Exception
public java.lang.Object getProcessorTemplates(int type, boolean refresh) throws java.lang.Exception
type
- int specifies the type or processors to returnrefresh
- boolean flag that specifies the data retrieval location.
java.lang.Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |