com.filenet.eforms.api

Class P8FormUtil

java.lang.Object
com.filenet.eforms.api.P8FormUtil

public class P8FormUtil
extends java.lang.Object

Field Summary

Modifier and Type	Field and Description
static java.lang.String	`FORM_POLICY`
static java.lang.String	`FORM_POLICY_LAUNCHED_WORKFLOW_NUMBER`
static java.lang.String	`FORM_PROXY`
static java.lang.String	`FORM_TEMPLATE`
static java.lang.String	`FORM_TYPE`
static java.lang.String	`ITX_FORM_TEMPLATE`
static java.lang.String	`TYPE_DOCUMENT`
static java.lang.String	`TYPE_WORKFLOW`

Constructor Summary

Constructor and Description
`P8FormUtil()`

Method Summary

Modifier and Type	Method and Description
static void	`connectDocumentFormData(com.filenet.wcm.api.Session session,P8ObjectRef dataRef,P8ObjectRef policyRef)` Helper method for setting the CE Object Value properties on the Form Data instance to associate the Form Policy and Form Template.
static void	`connectWorkflowFormData(com.filenet.wcm.api.Session session,P8ObjectRef dataRef,P8ObjectRef policyRef,java.lang.String runningWorkflowNumber)` Helper method for setting the CE Object Value properties on the Form Data instance to associate the Form Policy and Form Template.
static java.lang.Object	`getFormData(com.filenet.wcm.api.Session session,java.lang.String objectStoreName,java.lang.String formId,java.lang.String runningWorkflowNumber)` Helper method for retrieving the Form Data instance information associated with current Workflow step.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

FORM_TEMPLATE

public static final java.lang.String FORM_TEMPLATE

See Also:

Constant Field Values

FORM_POLICY

public static final java.lang.String FORM_POLICY

See Also:

Constant Field Values

FORM_POLICY_LAUNCHED_WORKFLOW_NUMBER

public static final java.lang.String FORM_POLICY_LAUNCHED_WORKFLOW_NUMBER

See Also:

Constant Field Values

FORM_TYPE

public static final java.lang.String FORM_TYPE

See Also:

Constant Field Values

FORM_PROXY

public static final java.lang.String FORM_PROXY

See Also:

Constant Field Values

ITX_FORM_TEMPLATE

public static final java.lang.String ITX_FORM_TEMPLATE

See Also:

Constant Field Values

TYPE_DOCUMENT

public static final java.lang.String TYPE_DOCUMENT

See Also:

Constant Field Values

TYPE_WORKFLOW

public static final java.lang.String TYPE_WORKFLOW

See Also:

Constant Field Values

Constructor Detail

P8FormUtil

public P8FormUtil()

Method Detail

getFormData

public static java.lang.Object getFormData( com.filenet.wcm.api.Session session,
java.lang.String objectStoreName,
java.lang.String formId,
java.lang.String runningWorkflowNumber)
throws java.lang.Exception

Helper method for retrieving the Form Data instance information associated with current Workflow step. Will return the current version information for the Form Data instance. May return a single ObjectRef or a list of ObjectRef objects if more than one Form Data instance is returned in the query. The formId parameter is for the Form Template used to create the Form Data. This parameter can be used to filter the results if more than one Form Data is returned. If formId is null, no filtering will take place and the return value could either be a single ObjectRef or a array of ObjectRefs.

Parameters:

session - Session object from Java API

objectStoreName - String holding object store name for the form data object

formId - String holding form template object id (maybe null)

runningWorkflowNumber - String holding the running workflow number

Returns:

P8ObjectRef object holding form data instance reference information

Throws:

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

connectDocumentFormData

public static void connectDocumentFormData( com.filenet.wcm.api.Session session,
P8ObjectRef dataRef,
P8ObjectRef policyRef)
throws java.lang.Exception

Parameters:

session - Session object from Java API

dataRef - P8ObjectRef holding Content Engine reference information for the Form Data instance. The dataRef should specify the objecStoreName and objectId of the specific Form Data instance.

policyRef - P8ObjectRef holding Content Engine reference information for the Document Form Policy. The policyRef should specify the objecStoreName and objectId of the specific Form Policy object.

Throws:

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

connectWorkflowFormData

public static void connectWorkflowFormData( com.filenet.wcm.api.Session session,
P8ObjectRef dataRef,
P8ObjectRef policyRef,
java.lang.String runningWorkflowNumber)
throws java.lang.Exception

Helper method for setting the CE Object Value properties on the Form Data instance to associate the Form Policy and Form Template. The actual Form Template reference information will be retrieved from the Policy content. This method will also create the FormProxy object for the running Workflow. This object is used internally to associate running Workflow Steps with the Workflow Form Policy. This method will not Launch, Complete or Dispatach a Workflow step. It can only be used to establish connectivity. It is a requirement that the Workflow be Launched before calling this method. The running Workflow number is a required parameter. If there is an existing FormProxy object that specifies the same running Workflow Number a IllegalArgumentException will be thrown.

Parameters:

session - Session object from Java API.

dataRef - P8ObjectRef holding Content Engine reference information for the Form Data instance. The dataRef should specify the objecStoreName and objectId of the specific Form Data instance.

policyRef - P8ObjectRef holding Content Engine reference information for the Workflow Form Policy. The policyRef should specify the objecStoreName and objectId of the specific Form Policy object.

runningWorkflowNumber - String holding the running Workflow number.

Throws:

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