com.filenet.wcm.toolkit.server.dp

Class WcmEProcessDataProvider

java.lang.Object
com.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

All implemented interfaces:

WcmDpModuleInterface, WcmModuleInterface

public class WcmEProcessDataProvider
extends WcmDpModule

Handles data provided from the eProcess Java API.

Field Summary

Modifier and Type	Field and Description
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

Constructor and Description
`WcmEProcessDataProvider()`

Method Summary

Modifier and Type	Method and Description
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()`
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.
static java.lang.String	`findNodeAttNameByAttName(org.w3c.dom.NodeList childList,java.lang.String nameToFind)`
static java.lang.String	`findNodeAttNameValueByAttName(org.w3c.dom.NodeList childList,java.lang.String nameToFind)`
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.String	`getAttNameByAttName(org.w3c.dom.Document xmlDoc,java.lang.String NametoFind,java.lang.String path)`
java.lang.String	`getAttNameValueByAttName(org.w3c.dom.Document xmlDoc,java.lang.String NametoFind,java.lang.String path)`
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.
java.lang.String[]	`getFieldValues(org.w3c.dom.Document xmlDoc,java.lang.String paramName)`
int	`getIsolatedRegion()` Gets the isolated region number for the current session.
java.lang.Object	`getLaunchedWorkflows(int maxQueryCount,boolean showStepNameColumn,boolean containsMilestones,boolean refresh)` Get the user-launched workflows by performing a "RosterQuery" against the PE.
int	`getLaunchedWorkflowsCount()` Retrieves the total count of items in the Launched Workflows query.
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.
java.lang.Object	`getMilestonesFromRoster(java.lang.String queueName,java.lang.String wobNum,int level,boolean lastOnly,boolean reachedOnly,boolean refresh)`
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.String	`getQueueNameFromRosterElementInternal(filenet.vw.api.VWRosterElement vwRosterElement)`
java.lang.Object	`getRosterElement(java.lang.String queueName,java.lang.String wobNum,boolean refresh,boolean lockItem)`
java.util.ArrayList	`getRosterFieldsList(org.w3c.dom.Document xmlDoc)`
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.String	`getStepNameFromRosterElementInternal(filenet.vw.api.VWRosterElement vwRosterElement)`
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.
java.lang.String[]	`getValuesByAttName(org.w3c.dom.Document xmlDoc,java.lang.String attName,java.lang.String nameToFind,java.lang.String path)` Get parameter values from XML document.
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	`getWobNumber(java.lang.String workflowNumber)` Retrieve the work object number from the the running workflow number.
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()`
void	`persist()`
java.lang.String	`removeInvalidXMLCharacters(java.lang.String inXML)`
void	`resetClassProperties(boolean clearQueueData)` Reset data provider class properties.
void	`resetClassProperties(boolean clearQueueData,boolean clearStepData)` Reset data provider class properties.
void	`setAttNameByAttValue(org.w3c.dom.Document xmlDoc,java.lang.String elementTagName,java.lang.String attName,java.lang.String attValue)`
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.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

TYPE

public static final java.lang.String TYPE

Defines the data provider type

See Also:

Constant Field Values

STEP_PROCESSOR

public static final int STEP_PROCESSOR

Defines the step processor mode.

See Also:

Constant Field Values

LAUNCH_PROCESSOR

public static final int LAUNCH_PROCESSOR

Defines the launch step processor mode.

See Also:

Constant Field Values

QUEUE_INFORMATION

public static final int QUEUE_INFORMATION

Defines the queue information mode.

See Also:

Constant Field Values

ENTRY_PROCESSOR

public static final int ENTRY_PROCESSOR

Defines the launch step processor mode for the entry template workflow .

See Also:

Constant Field Values

QUEUE_TYPE_PROCESS

public static final java.lang.String QUEUE_TYPE_PROCESS

Defines the queue type process.

QUEUE_TYPE_CENTRIC

public static final java.lang.String QUEUE_TYPE_CENTRIC

Defines the queue type user centric.

QUEUE_TYPE_SYSTEM

public static final java.lang.String QUEUE_TYPE_SYSTEM

Defines the queue type system

TIME_MASK_CANONICAL

public static final java.lang.String TIME_MASK_CANONICAL

Defines the time mask used for date data fields

See Also:

Constant Field Values

USERS

public static final int USERS

Defines the participant retrieval behavior for only users.

See Also:

Constant Field Values

GROUPS

public static final int GROUPS

Defines the participant retrieval behavior for only groups.

See Also:

Constant Field Values

USERSGROUPS

public static final int USERSGROUPS

Defines the participant retrieval behavior for users and groups together.

See Also:

Constant Field Values

STATE_NONE

public static final java.lang.String STATE_NONE

Defines no state specified for data field

See Also:

Constant Field Values

STATE_CLEAN

public static final java.lang.String STATE_CLEAN

Defines clean state specified for data field

See Also:

Constant Field Values

STATE_MODIFIED

public static final java.lang.String STATE_MODIFIED

Defines modified state specified for data field

See Also:

Constant Field Values

STATE_NOT_VALID

public static final java.lang.String STATE_NOT_VALID

Defines not valid (and modified) state specified for data field

See Also:

Constant Field Values

STATE_MARKED_REMOVE

public static final java.lang.String STATE_MARKED_REMOVE

Defines marked removed state specified for data field

See Also:

Constant Field Values

SYSTEMMAP_WORKFLOW

public static final java.lang.String SYSTEMMAP_WORKFLOW

Defines the Workflow system map name contained in the workflow definition.

See Also:

Constant Field Values

SYSTEMMAP_TERMINATE

public static final java.lang.String SYSTEMMAP_TERMINATE

Defines the Terminate system map name contained in the workflow definition.

See Also:

Constant Field Values

SYSTEMMAP_MALFUNCTION

public static final java.lang.String SYSTEMMAP_MALFUNCTION

Defines the Malfunction system map name contained in the workflow definition.

See Also:

Constant Field Values

SYSTEMMAP_QUEUE_ASSERTION

public static final java.lang.String SYSTEMMAP_QUEUE_ASSERTION

Defines the QueueAssertionViolation system map name contained in the workflow definition.

See Also:

Constant Field Values

SYSTEMMAP_RECOVERY

public static final java.lang.String SYSTEMMAP_RECOVERY

Defines the Recovery system map name contained in the workflow definition.

See Also:

Constant Field Values

SYSTEMMAP_TRACKER

public static final java.lang.String SYSTEMMAP_TRACKER

Defines the Tracker system map name contained in the workflow definition.

See Also:

Constant Field Values

SEARCH_TYPE_CUSTOM

public static final int SEARCH_TYPE_CUSTOM

Defines the user or group search type custom.

See Also:

Constant Field Values

SEARCH_TYPE_PREFIX_MATCH

public static final int SEARCH_TYPE_PREFIX_MATCH

Defines the user or group search type prefix match.

See Also:

Constant Field Values

SEARCH_TYPE_SUFFIX_MATCH

public static final int SEARCH_TYPE_SUFFIX_MATCH

Defines the user or group search type suffix match.

See Also:

Constant Field Values

SEARCH_TYPE_CONTAINS

public static final int SEARCH_TYPE_CONTAINS

Defines the user or group search type contains.

See Also:

Constant Field Values

SORT_TYPE_NONE

public static final int SORT_TYPE_NONE

Defines the user or group sort type none.

See Also:

Constant Field Values

SORT_TYPE_ASCENDING

public static final int SORT_TYPE_ASCENDING

Defines the user or group sort type ascending.

See Also:

Constant Field Values

SORT_TYPE_DESCENDING

public static final int SORT_TYPE_DESCENDING

Defines the user or group sort type descending.

See Also:

Constant Field Values

NO_DATE_VALUE

public static final java.lang.String NO_DATE_VALUE

Defines a long constant being used for generating an empty date value.

See Also:

Constant Field Values

Constructor Detail

WcmEProcessDataProvider

public WcmEProcessDataProvider( )

Method Detail

initialize

public void initialize()
throws java.lang.Exception

Description copied from class: WcmModule

Called by WcmController when the module is registered, and has access to the data store. Do "constructor" types of things here.

Specified by:

initialize in interface WcmModuleInterface

Overrides:

initialize in class WcmModule

Throws:

java.lang.Exception

getStepElementState

public WcmStepElementState getStepElementState( )
throws java.lang.Exception

Get the step element state class instance currently being used by the data provider.

Returns:

WcmStepElementState the cached step element state class

Throws:

java.lang.Exception - if there were errors retrieving data

clearStepElementState

public void clearStepElementState( )
throws java.lang.Exception

Clear the data in the step element state class currently used by the data provider.

Throws:

java.lang.Exception - if there were errors retrieving data

persist

public void persist()
throws java.lang.Exception

Description copied from class: WcmModule

Called by WcmController before cleanup(), when it's about to go to another Java™Server Pages (JSP) page. This is intended for future use.

Specified by:

persist in interface WcmModuleInterface

Overrides:

persist in class WcmModule

Throws:

java.lang.Exception

cleanup

public void cleanup()
throws java.lang.Exception

Description copied from class: WcmModule

Called by WcmController after persist(), when it's about to go to another JSP page. The module should null out any module properties that it can re-construct later to minimize memory consumption.

Specified by:

cleanup in interface WcmModuleInterface

Overrides:

cleanup in class WcmModule

Throws:

java.lang.Exception

setClassProperty

public void setClassProperty(java.lang.String key,
java.lang.Object value)
throws java.lang.Exception

Set a key-value in the data store. The key that you pass here is internally scoped to the class. These are shared between all instances of a module class.

Overrides:

setClassProperty in class WcmModule

Parameters:

key - The key name to use.

value - The value to set. null is valid, and clears the key.

Throws:

java.lang.Exception - If there are problems retrieving data.

getClassProperty

public java.lang.Object getClassProperty( java.lang.String key)
throws java.lang.Exception

Get a key-value in the data store. The key that you get here is internally scoped to the class. These are shared between all instances of a module class.

Overrides:

getClassProperty in class WcmModule

Parameters:

key - The key name to use.

Returns:

The value associated with the key, or null.

Throws:

java.lang.Exception - If there are problems retrieving data.

resetClassProperties

public void resetClassProperties( boolean clearQueueData)
throws java.lang.Exception

Reset data provider class properties.

Parameters:

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.

Throws:

java.lang.Exception - If there are problems retrieving data.

resetClassProperties

public void resetClassProperties( boolean clearQueueData,
boolean clearStepData)
throws java.lang.Exception

Reset data provider class properties.

Parameters:

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.

Throws:

java.lang.Exception - If there are problems retrieving data.

doStepElementAbort

public void doStepElementAbort( )
throws java.lang.Exception

Unlocks a work item associated with this step without updating the fields on the work item.

Throws:

java.lang.Exception - If there are problems retrieving data.

doStepElementDispatch

public void doStepElementDispatch( )
throws java.lang.Exception

Completes this step by moving to the next workflow step. Saves changes made in the workflow at this step.

Throws:

java.lang.Exception - If there are problems retrieving data.

doStepElementReassign

public void doStepElementReassign( java.lang.String participant,
boolean delegateFlag)
throws java.lang.Exception

Changes the participant responsible for processing the current step.

Parameters:

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.

Throws:

java.lang.Exception - If there are problems retrieving data.

doStepElementReassign

public void doStepElementReassign( java.lang.String domainId,
java.lang.String participant,
boolean delegateFlag)
throws java.lang.Exception

Changes the participant responsible for processing the current step.

Parameters:

domainId - String the domain id of the participant

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.

Throws:

java.lang.Exception - If there are problems retrieving data.

doStepElementSave

public void doStepElementSave(boolean unlock)
throws java.lang.Exception

Saves the work item associated with this step element.

Parameters:

unlock - Specify true to save and unlock the work item; specify false to maintain the current lock and save the work item.

Throws:

java.lang.Exception - If there are problems retrieving data.

doStepElementReturn

public void doStepElementReturn( )
throws java.lang.Exception

Returns the work item to the queue from which a user originally reassigned or delegated the work item.

Throws:

java.lang.Exception - If there are problems retrieving data.

doStepElementMoveToInbox

public void doStepElementMoveToInbox( )
throws java.lang.Exception

Moves work item to the current user inbox.

Throws:

java.lang.Exception - If there are problems retrieving data.

doCreateWorkflow

public java.lang.Object doCreateWorkflow( java.lang.String workflowIdentifier,
java.lang.String subject,
java.lang.String attachmentId)
throws java.lang.Exception

Launch a workflow from the currently transferred workflow definition. The system assumes that the first step in the definition is a launch step.

Parameters:

workflowIdentifier - Visual WorkFlo version string

subject - Workflow subject from linker

attachmentId - Main workflow attachment

Returns:

XML document object

Throws:

java.lang.Exception - If there are problems retrieving data.

getUserQueues

public java.lang.Object getUserQueues( boolean refresh)
throws java.lang.Exception

Retrieves a collection of User Queues as XML.

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.

Parameters:

refresh - Boolean flag that specifies the data retrival location.

Returns:

Object holding the XML string containing the collection information.

Throws:

java.lang.Exception - If there are problems retreving collection data.

fetchUserQueueNames

public java.lang.String[] fetchUserQueueNames( boolean refresh)
throws java.lang.Exception

Fetches user queue names

Parameters:

refresh - True to retrieve map names from VWSession; otherwise, fetch the in-memory copy

Returns:

string array of user queue names

Throws:

java.lang.Exception - If there are problems retrieving data.

getVWQueue

public filenet.vw.api.VWQueue getVWQueue( java.lang.String name)
throws java.lang.Exception

Get the queue by name.

Parameters:

name -

Returns:

The VWQueue.

Throws:

java.lang.Exception

getPublicQueues

public java.lang.Object getPublicQueues( boolean refresh)
throws java.lang.Exception

Retrieves a collection of Public Queues as XML.

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.

Parameters:

refresh - Boolean flag that specifies the data retrival location.

Returns:

Object holding the XML string containing the collection information.

Throws:

java.lang.Exception - If there are problems retreving collection data.

getQueueElements

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

Retrieves a collection of Queue Elements as XML.

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.

Parameters:

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.

Returns:

Object holding the XML string containing the collection information.

Throws:

java.lang.Exception - If there are problems retreving collection data.

getQueueElements

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

Retrieves a collection of Queue Elements as XML. User can specify filter parameters (basically SQL statements) to retrieve a filtered list of items from the Process Engine.

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.

Parameters:

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.

Returns:

Object holding the XML string containing the collection information.

Throws:

java.lang.Exception - If there are problems retreving collection data.

getQueueElements

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

Retrieves a collection of Queue Elements as XML. User can specify filter parameters (basically SQL statements) to retrieve a filtered list of items from the Process Engine. Or, in the case of filtering on a stepName, the user may pass in a stepName and an operator as arguments. If either stepName or operator args are null then the filter is ignored.