Collaboration API Documentation

com.filenet.bso.api.util
Interface BsoWorkflow


public interface BsoWorkflow

Classes that implement the BsoWorkflow interface represent FileNet eProcess workflows.


Method Summary
 filenet.vw.api.VWStepElement createWorkflow(java.util.Map parameterMap)
          Creates, but does not launch, a workflow.
 java.lang.String getDescription()
          Returns the description associated with this workflow.
 java.lang.String getID()
          Returns the ID associated with this workflow.
 java.lang.String getName()
          Returns the name associated with this workflow.
 void launchWorkflow()
          Launches the workflow.
 void setParameterValue(java.lang.String name, java.lang.Object value, boolean required)
          Assigns a given value to a workflow parameter field.
 

Method Detail

getName

public java.lang.String getName()
Returns the name associated with this workflow.

Returns:
A String containing the workflow name.

getID

public java.lang.String getID()
Returns the ID associated with this workflow.

Returns:
A String containing the workflow identifier.

getDescription

public java.lang.String getDescription()
Returns the description associated with this workflow.

Returns:
A String containing the workflow description.

createWorkflow

public filenet.vw.api.VWStepElement createWorkflow(java.util.Map parameterMap)
                                            throws filenet.vw.api.VWException
Creates, but does not launch, a workflow.

This method supports the case where an application requires direct access to the step element before launch.

The map object you pass to this method may contain values that will be assigned to parameter fields of the workflow. Within the map, the key names and workflow parameter field names must match. If they do not match, the assignment of values to parameter fields will not succeed.

Parameters:
Map - A Java Map object that contains the data to assign to workflow parameter fields.

Returns:
A VWStepElement object that represents the launch step of the workflow.

Throws:
filenet.vw.api.VWException - Thrown if the create operation fails.

setParameterValue

public void setParameterValue(java.lang.String name,
                              java.lang.Object value,
                              boolean required)
                       throws filenet.vw.api.VWException
Assigns a given value to a workflow parameter field.

If the required parameter is set to true, the workflow parameter field you specify in the name parameter must exist; if it does not, this method throws a VWException. If the required parameter is set to false, no error is thrown if that parameter field is unavailable.

Parameters:
name - A String containing the name of the workflow parameter field.

value - A Java Object that represents the value to assign to the workflow parameter field specified by the name parameter.

required - If set to true, the workflow parameter field specified by the name must exist.

Throws:
filenet.vw.api.VWException - Thrown if the operation fails.

launchWorkflow

public void launchWorkflow()
                    throws filenet.vw.api.VWException
Launches the workflow. The createWorkflow() method must be called before calling this method.

The workflow could also be launched by calling the doDispatch() method of the VWStepElement object that is returned by the createWorkflow() method.

Throws:
filenet.vw.api.VWException - Thrown if the workflow launch fails.

Collaboration API Documentation

Copyright © 2002 - 2004 FileNet Corporation. All rights reserved.