|
Collaboration API Documentation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
public java.lang.String getName()
String
containing the workflow name.public java.lang.String getID()
String
containing the workflow identifier.public java.lang.String getDescription()
String
containing the workflow description.public filenet.vw.api.VWStepElement createWorkflow(java.util.Map parameterMap) throws filenet.vw.api.VWException
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.
Map
- A Java Map
object that contains the data to assign
to workflow parameter fields.
VWStepElement
object that represents the launch step
of the workflow.
filenet.vw.api.VWException
- Thrown if the create operation fails.public void setParameterValue(java.lang.String name, java.lang.Object value, boolean required) throws filenet.vw.api.VWException
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.
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.
filenet.vw.api.VWException
- Thrown if the operation fails.public void launchWorkflow() throws filenet.vw.api.VWException
The workflow could also be launched by calling the doDispatch()
method of the VWStepElement
object that is returned by the
createWorkflow()
method.
filenet.vw.api.VWException
- Thrown if the workflow launch fails.
|
Collaboration API Documentation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |