Process Class Relationships

filenet.vw.api
Class VWWorkflowDefinition

java.lang.Object
  |
  +--filenet.vw.api.VWWorkflowDefinition
All Implemented Interfaces:
java.io.Serializable

public final class VWWorkflowDefinition
extends java.lang.Object
implements java.io.Serializable

Use this class to create, delete, and access a workflow definition object and its sub-objects.

A workflow definition is a user-created graphical map showing the sequences, resources, and routing logic of the specific steps needed to complete a business process. The workflow definition contains the following data:

A workflow definition object is the basis of an authored workflow. A user begins to define a workflow by creating this object. The VWWorkflowDefinition object or one of its sub-objects stores all workflow-associated information. A workflow persists when an application saves a workflow definition object to a file or restores one from a file.

Since:
VWWS3.10
See Also:
VWMapDefinition, VWFieldDefinition, VWException, Serialized Form

Field Summary
static int LVALUE
          Value of 0: this constant can be used to subscript into the pre or post assignment arrays.
static int RVALUE
          Value of 1: this constant can be used to subscript into the pre or post assignment arrays.
 
Constructor Summary
VWWorkflowDefinition()
          Public constructor for the VWWorkflowDefinition class.
 
Method Summary
 java.lang.String AsXMLString()
          Retrieves an XML formatted representation of this workflow definition.
 VWFieldDefinition createFieldUsingObject(java.lang.String theName, java.lang.Object theValue)
          Creates a data field in this workflow definition, with values initialized by an object.
 VWFieldDefinition createFieldUsingString(java.lang.String theName, java.lang.String theValueString, int theType, boolean theIsArray)
          Creates a data field in this workflow definition, with values initialized by a field.
 VWMapDefinition createMap(java.lang.String theName)
          Creates a new map in this workflow definition.
 VWMilestoneDefinition createMilestone(java.lang.String theName)
          Creates a new milestone in this workflow definition.
 VWRuleSetDefinition createRuleSet(java.lang.String theValue)
          Creates a new VWRuleSetDefinition objects in this workflow.
 void deleteField(java.lang.String theName)
          Deletes a field definition from the workflow definition.
 void deleteMap(int theMapId)
          Deprecated. Replaced by deleteMap(String)
 void deleteMap(java.lang.String theMapName)
          Deletes the specified map from this workflow definition.
 void deleteMilestone(java.lang.String theName)
          Deletes the specified milestone from this workflow definition.
 void deleteRuleSet(VWRuleSetDefinition theRuleSet)
          Deletes a rule set definition from this workflow definition.
 VWAttributeInfo getAttributeInfo()
          Gets a VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format.
 java.lang.String getAuthorTool()
          Gets the value of this workflow definition's authorTool property.
 java.lang.String getBaseWorkClassName()
          Gets the value of this workflow definition's base work class name, which is the name of the work class from which this workflow definition will inherit, at transfer or initialization.
 long getDeadline()
          Retrieves the value of the deadline property for this workflow definition.
 java.lang.String getDescription()
          Gets the value in the description property of this workflow definition.
 java.lang.String getEventLogName()
          Gets this workflow definition's event log name, which applies to the transfer or initialization of event logs.
 VWFieldDefinition getField(java.lang.String theName)
          Gets the definition of a data field from this workflow definition.
 VWFieldDefinition[] getFields()
          Gets the set of fields associated with this workflow definition.
 VWStepDefinition getLaunchStep()
          Gets the VWStepDefinition object of the launch step in this workflow definition.
 java.lang.String getMainAttachmentName()
          Gets the name of the main attachment of this workflow definition.
 VWMapDefinition getMainMap()
          Gets the definition object that represents the main map in this workflow definition.
 VWMapDefinition getMap(int theMapId)
          Deprecated. Replaced by getMap(String).

Note getMap(String) takes a map name as a parameter, rather than a Map ID.

 VWMapDefinition getMap(java.lang.String theName)
          Retrieves a workflow map definition for the specified name.
 VWMapDefinition[] getMaps()
          Gets the set of workflow maps associated with this workflow definition.
 VWMilestoneDefinition getMilestone(java.lang.String theName)
          Gets the definition of a milestone from this workflow definition.
 VWMilestoneDefinition[] getMilestones()
          Retrieves the array of milestones for this workflow definition.
 java.lang.String getName()
          Gets the value of the name property for this workflow definition object.
 long getReminder()
          Retrieves the value of the reminder property for this workflow definition.
 java.lang.String getRosterName()
          Gets this workflow definition's roster work class name, that applies to the transfer or initialization of rosters.
 VWRuleSetDefinition[] getRuleSets()
          Retrieves the array of VWRuleSetDefinition objects for this workflow definition.
 VWWorkflowRuntimeId getRuntimeId()
          Gets the runtime ID for the workflow definition.
 java.lang.String getSubject()
          Gets the value in the subject property of this workflow definition.
 java.lang.String getTag()
          Gets the value in the tag expression of this workflow definition.
 VWFieldDefinition insertField(VWFieldDefinition theField)
          Inserts a field in this workflow definition.
 VWMapDefinition insertMap(VWMapDefinition theMap)
          Inserts a map in this workflow definition.
 VWMilestoneDefinition insertMilestone(VWMilestoneDefinition theMilestone)
          Inserts a milestone in this workflow definition.
static VWWorkflowDefinition read(java.io.InputStream theStream)
          Evaluates a workflow definition from an input stream.
static VWWorkflowDefinition readFromFile(java.lang.String theFileName)
          Evaluates a workflow definition from a file.
 void setAttributeInfo(VWAttributeInfo theAttributeInfo)
          Sets a VWAttribute object containing attributes for this object.
 void setAuthorTool(java.lang.String theAuthorTool)
          Changes the value of this workflow definition's authorTool property.
 void setBaseWorkClassName(java.lang.String theBaseWorkClassName)
          Changes the value of this workflow definition's base work class name, which is the name of the work class from which this workflow definition will inherit upon transfer/ or initialization.
 void setDeadline(long theDeadline)
          Changes the value of the deadline property for this workflow definition.
 void setDescription(java.lang.String theDescription)
          Changes the value of the description property of this workflow definition.
 void setEventLogName(java.lang.String theEventLogName)
          Changes the value of the event log name for this workflow definition.
 void setMainAttachmentName(java.lang.String theName)
          Modifies the value of the main attachment name property of this workflow definition.
 void setMilestones(VWMilestoneDefinition[] theMilestones)
          Sets the array of milestones for this workflow definition by reordering but not adding or deleting milestones, with the following Restriction:
 void setName(java.lang.String theName)
          Changes the value of the name property for this workflow definition.
 void setReminder(long theReminder)
          Changes the value of the reminder property for this workflow definition.
 void setRosterName(java.lang.String theRosterName)
          Changes the value of the roster work class name for this workflow definition.
 void setSubject(java.lang.String theSubject)
          Modifies the value of the subject property of this workflow definition.
 void setTag(java.lang.String theTag)
          Changes the value of the tag property of this workflow definition.
 java.lang.String toString()
          Gets the String version of the workflow subject.
 void toXML(java.lang.StringBuffer theBuffer)
          Appends an XML String that represents this VWWorkflowDefinition object to the buffer specified by the input parameter.
 VWValidationError[] validate(VWSession theSession, boolean fixupSteps)
          Validates an instance of a VWWorkflowDefinition object.
 void write(java.io.OutputStream theStream)
          Writes this VWWorkflowDefinition object to an output stream.
 void writeToFile(java.lang.String theFileName)
          Writes this VWWorkflowDefinition object to a file.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

LVALUE

public static final int LVALUE
Value of 0: this constant can be used to subscript into the pre or post assignment arrays.

RVALUE

public static final int RVALUE
Value of 1: this constant can be used to subscript into the pre or post assignment arrays.
Constructor Detail

VWWorkflowDefinition

public VWWorkflowDefinition()
                     throws VWException
Public constructor for the VWWorkflowDefinition class.
Throws:
VWException -  
Method Detail

validate

public VWValidationError[] validate(VWSession theSession,
                                    boolean fixupSteps)
                             throws VWException
Validates an instance of a VWWorkflowDefinition object.

Note A session object is required to perform certain parts of the validation process. You can either pass in a valid VWSession object or null for the input parameter. If you pass null, validation tests that require a logon will not be reported as validated.

Parameters:
theSession - The current VWSession object. Null is allowed.

fixupSteps - A boolean value. Specify true to set the joinStepId values for steps that are AND-splits. When you specify false, the system does not set the join step IDs. You can also specify false to cause the system to assume that the caller has already set the join step IDs.
Returns:
An array of objects that describe the validation errors encountered if the workflow is invalid. If the workflow definition is valid, the method returns null.
Throws:
VWException -  

createFieldUsingObject

public VWFieldDefinition createFieldUsingObject(java.lang.String theName,
                                                java.lang.Object theValue)
                                         throws VWException
Creates a data field in this workflow definition, with values initialized by an object.
Parameters:
theName - The name of the field to create.

theValue - An object containing the value to place in the newly created field. The type can be one of the following types, or the value can be a single dimensional array, whose elements are of one of the following types:

  • Integer
  • String
  • Boolean
  • Double
  • Date
  • VWAttachment
  • VWParticipant
Returns:
A VWFieldDefinition object that represents the newly created data field.
Throws:
VWException -  
See Also:
VWFieldType, VWFieldDefinition

createFieldUsingString

public VWFieldDefinition createFieldUsingString(java.lang.String theName,
                                                java.lang.String theValueString,
                                                int theType,
                                                boolean theIsArray)
                                         throws VWException
Creates a data field in this workflow definition, with values initialized by a field.
Parameters:
theName - The name of the field to create.

theValueString - The initial value for the data field.

theType - An integer value specifying the data type to which the value expression should evaluate.

theIsArray - Specify true to indicate that the value expression is to evaluate to an array; otherwise, specify FALSE.
Returns:
A VWFieldDefinition object that represents the newly created data field.
Throws:
VWException -  
See Also:
VWFieldType, VWFieldDefinition

deleteField

public void deleteField(java.lang.String theName)
                 throws VWException
Deletes a field definition from the workflow definition.
Parameters:
theName - The name of the field definition to delete. The name can be passed to this method from a set of field definitions associated with this workflow definition.
Throws:
VWException - Thrown if the system encounters an error while attempting to delete the field, or if the system cannot find the specified field.
See Also:
VWFieldDefinition

createMap

public VWMapDefinition createMap(java.lang.String theName)
                          throws VWException
Creates a new map in this workflow definition.
Parameters:
theName - The name of the new map.
Returns:
The newly created map definition.
Throws:
VWException -  
See Also:
VWMapDefinition

insertMap

public VWMapDefinition insertMap(VWMapDefinition theMap)
                          throws VWException
Inserts a map in this workflow definition. This method can be useful for copying maps from one VWWorkflowDefinition to another.
Parameters:
theMap - A map to be inserted into this workflow definition.
Returns:
The newly inserted map definition.
Throws:
VWException - Thrown if a map with the same name as the map being inserted already exists in this workflow definition.
See Also:
VWMapDefinition

insertField

public VWFieldDefinition insertField(VWFieldDefinition theField)
                              throws VWException
Inserts a field in this workflow definition. This method can be useful for copying fields from one VWWorkflowDefinition to another.
Parameters:
theField - a field to be inserted into this workflow definition.
Returns:
The newly inserted field definition.
Throws:
VWException - Thrown if a field with the same name as the field being inserted already exists in this workflow definition.
See Also:
VWFieldDefinition

insertMilestone

public VWMilestoneDefinition insertMilestone(VWMilestoneDefinition theMilestone)
                                      throws VWException
Inserts a milestone in this workflow definition. This method can be useful for copying milestones from one VWWorkflowDefinition to another.
Parameters:
theMilestone - A milestone to be inserted into this workflow definition.
Returns:
The newly inserted milestone definition.
Throws:
VWException - Thrown if a milestone with the same name as the milestone being inserted already exists in this workflow definition.
See Also:
VWMilestoneDefinition

deleteMap

public void deleteMap(int theMapId)
               throws VWException
Deprecated. Replaced by deleteMap(String)

Note: Currently unsupported, this method throws an exception if called at runtime. This method was originally intended to delete a workflow map definition, specified by map ID.
Parameters:
theMapId - An integer that contains the ID of the map to delete.
Throws:
VWException - Note Always thrown.
See Also:
VWMapDefinition

deleteMap

public void deleteMap(java.lang.String theMapName)
               throws VWException
Deletes the specified map from this workflow definition.
Note
The "main" map, whose name is "Workflow", can never be deleted.
Parameters:
theMapName - The name of the map to be deleted.
Throws:
VWException - Thrown , for example, if the input map name is "Workflow".
See Also:
VWMapDefinition

getName

public java.lang.String getName()
Gets the value of the name property for this workflow definition object.
Returns:
The name of this workflow definition.

setName

public void setName(java.lang.String theName)
             throws VWException
Changes the value of the name property for this workflow definition.
Parameters:
theName - The name of this workflow definition. The name cannot begin with a sequence of two tildes ("~~"), because "~~" is reserved.
Throws:
VWException - Thrown if the name specified in the theName parameter is invalid.

getBaseWorkClassName

public java.lang.String getBaseWorkClassName()
Gets the value of this workflow definition's base work class name, which is the name of the work class from which this workflow definition will inherit, at transfer or initialization.
Returns:
The base class name of this workflow definition. Will return "WorkObjectEx" unless a call has been made to setBaseWorkClassName to change the base work class name to a different value.
See Also:
setBaseWorkClassName(String)

setBaseWorkClassName

public void setBaseWorkClassName(java.lang.String theBaseWorkClassName)
                          throws VWException
Changes the value of this workflow definition's base work class name, which is the name of the work class from which this workflow definition will inherit upon transfer/ or initialization.
Parameters:
theBaseWorkClassName - The new name of the work class from which this workflow definition will inherit upon transfer or initialization.
Throws:
VWException - Thrown if the name does not indicate a valid base work class.

getRosterName

public java.lang.String getRosterName()
Gets this workflow definition's roster work class name, that applies to the transfer or initialization of rosters.
Returns:
The roster name for this workflow definition, or null. Null means the roster inherits its name property from the base work class.

setRosterName

public void setRosterName(java.lang.String theRosterName)
                   throws VWException
Changes the value of the roster work class name for this workflow definition. This workflow definition uses this roster name during transfer or initialization processes.
Parameters:
theRosterName - Name of the roster that this workflow definition uses during transfer or initialization processes, or null. Null means that the roster name property will be inherited from the base work class.
Throws:
VWException - Thrown if the roster name is invalid.

getEventLogName

public java.lang.String getEventLogName()
Gets this workflow definition's event log name, which applies to the transfer or initialization of event logs.
Returns:
The event log name for this workflow definition, or null. Null means the event log inherits its name property from the base work class.

setEventLogName

public void setEventLogName(java.lang.String theEventLogName)
                     throws VWException
Changes the value of the event log name for this workflow definition. This workflow definition uses this event log name during transfer or initialization processes.
Parameters:
theEventLogName - Name of the event log that this workflow definition uses during transfer or initialization processes, or null. Null means that the event log name property will be inherited from the base work class.
Throws:
VWException - Thrown if the event log name is invalid.

getAuthorTool

public java.lang.String getAuthorTool()
Gets the value of this workflow definition's authorTool property. The authorTool property may be used to identify the application that generated this workflow definition.
Returns:
The authorTool property for this workflow definition. A null value is valid.

setAuthorTool

public void setAuthorTool(java.lang.String theAuthorTool)
                   throws VWException
Changes the value of this workflow definition's authorTool property. The authorTool property may be used to identify the application that generated this workflow definition.
Parameters:
theAuthorTool - The new authorTool property value for this workflow definition.
Throws:
VWException -  

getTag

public java.lang.String getTag()
Gets the value in the tag expression of this workflow definition.
Returns:
The tag expression.

setTag

public void setTag(java.lang.String theTag)
Changes the value of the tag property of this workflow definition.
Parameters:
theTag - The new tag expression for the workflow definition. The expression can be of any valid type. The expression must meet specific guidelines for expressions; for detailed information about expression guidelines refer to the Expressions book, in the Reference section, of the Designer online help.

getDescription

public java.lang.String getDescription()
Gets the value in the description property of this workflow definition.
Returns:
The contents of the description property for this workflow definition.

setDescription

public void setDescription(java.lang.String theDescription)
Changes the value of the description property of this workflow definition.
Parameters:
theDescription - The new description for this workflow definition.

getMainAttachmentName

public java.lang.String getMainAttachmentName()
Gets the name of the main attachment of this workflow definition.
Returns:
The name of the main attachment associated with this workflow definition. Pass this returned name to VWWorkflowDefinition.getField() to get the VWFieldDefinition object that represents the main attachment. If no associated main attachment exists, this method returns null.
See Also:
getField(java.lang.String), VWFieldDefinition, VWAttachment

setMainAttachmentName

public void setMainAttachmentName(java.lang.String theName)
                           throws VWException
Modifies the value of the main attachment name property of this workflow definition.
Parameters:
theName - The new main attachment name associated with this workflow definition. The name must be that of a field in this workflow definition, and the type of the field must be VWFieldType.FIELD_TYPE_ATTACHMENT. This value is available at runtime in the launch step as a String parameter called F_MAINATTACHMENT. Since the run time parameter is a String, the theName parameter must be a quoted String.
Throws:
VWException - Thrown if the specified field?s type is not VWFieldType .FIELD_TYPE_ATTACHMENT.
See Also:
VWFieldDefinition, VWFieldType

getField

public VWFieldDefinition getField(java.lang.String theName)
                           throws VWException
Gets the definition of a data field from this workflow definition.
Parameters:
theName - Name of the field that the returned definition describes.
Returns:
A VWFieldDefinition object that represents the data field specified in the theName parameter.
Throws:
VWException - Thrown if the system cannot find the field specified in the theName parameter.
See Also:
VWFieldDefinition

getFields

public VWFieldDefinition[] getFields()
                              throws VWException
Gets the set of fields associated with this workflow definition.
Returns:
An array of VWFieldDefinition objects that represent the data fields specified in the workflow definition.
Throws:
VWException - Thrown if it cannot get the set of fields associated with this workflow definition.
See Also:
VWFieldDefinition

getMainMap

public VWMapDefinition getMainMap()
                           throws VWException
Gets the definition object that represents the main map in this workflow definition. The map name is "Workflow", and its ID is zero (0).
Returns:
A VWDefinition object that represents the main map in this workflow definition.
Throws:
VWException - Thrown if the system cannot get the main map.
See Also:
VWMapDefinition

getLaunchStep

public VWStepDefinition getLaunchStep()
                               throws VWException
Gets the VWStepDefinition object of the launch step in this workflow definition. The launch step ID is zero (0), the step name is "LaunchStep", and it is contained in the map named "Workflow". The launch step is the first step to be executed when the workflow is launched. It cannot be deleted and cannot be the destination of any route.
Returns:
A VWDefinition object that represents the launch step in this workflow definition.
Throws:
VWException - Thrown if the system fails to get the launch step.
See Also:
VWMapDefinition, getMainMap(), VWMapDefinition.getStartStep()

getSubject

public java.lang.String getSubject()
Gets the value in the subject property of this workflow definition.
Returns:
The value in the subject property of this workflow definition.

setSubject

public void setSubject(java.lang.String theSubject)
Modifies the value of the subject property of this workflow definition.
Parameters:
theSubject - The new value of the subject property of this workflow definition.
Note: The subject is a String that must contain a valid String expression, so it requires internal quotes, as shown in the following example:

VWWorkflowDefinitionInstance.setSubject("\"my subject\"");


getMap

public VWMapDefinition getMap(int theMapId)
                       throws VWException
Deprecated. Replaced by getMap(String).

Note getMap(String) takes a map name as a parameter, rather than a Map ID.

Note: Currently unsupported, this method throws an exception if called at runtime. This method was originally intended to retrieve a workflow map definition, specified by map ID.
Parameters:
theMapId - An integer representing the ID of the map the returned definition describes.
Returns:
A VWMapDefinition object that represents the workflow map definition.
Throws:
VWException - WARNING: An exception is always thrown!
See Also:
VWMapDefinition

getMap

public VWMapDefinition getMap(java.lang.String theName)
                       throws VWException
Retrieves a workflow map definition for the specified name. The system searches the workflow maps associated with this workflow definition for the map that has the specified name.
Parameters:
theName - The name of the workflow map to retrieve.
Returns:
A VWMapDefinition object that represents the map of the workflow definition specified in the theName parameter.
Throws:
VWException - Thrown if the system cannot find the named map.
See Also:
VWMapDefinition

getMaps

public VWMapDefinition[] getMaps()
                          throws VWException
Gets the set of workflow maps associated with this workflow definition.
Returns:
An array of VWMapDefinition objects that represent all of the workflow maps associated with this workflow definition.
Throws:
VWException - Thrown if an error occurs retrieving the maps for this workflow definition.
See Also:
VWMapDefinition

getDeadline

public long getDeadline()
Retrieves the value of the deadline property for this workflow definition. The deadline value represents the number of minutes between launching of the workflow and the expiration of the deadline timer at runtime.
Returns:
A number indicating the deadline value expressed in minutes. A returned deadline value of 0 (zero) means the workflow has no deadline. A returned value of -1 means that the workflow has a deadline, but it is a time expression that cannot be converted to a long value.

setDeadline

public void setDeadline(long theDeadline)
                 throws VWException
Changes the value of the deadline property for this workflow definition.
Parameters:
theDeadline - A positive, long integer that is the number of minutes between launching of the workflow and the expiration of the workflow's deadline timer at runtime. A deadline value of 0 means the workflow has no deadline.
Throws:
VWException - Thrown if an error occurs, for example if the value specified in the theDeadline parameter is negative.

getReminder

public long getReminder()
Retrieves the value of the reminder property for this workflow definition.
Returns:
A positive, long integer indicating the number of seconds prior to expiration of the deadline timer that the reminder timer will expire at runtime. A reminder value of 0 (zero) means the step has no reminder.

setReminder

public void setReminder(long theReminder)
                 throws VWException
Changes the value of the reminder property for this workflow definition.
Parameters:
theReminder - A positive, long integer specifying the number of seconds prior to expiration of the deadline timer that the reminder timer will expire at runtime. A reminder value of 0 (zero) means the step has no reminder.
Throws:
VWException - Thrown if the reminder value specified in the theReminder parameter is negative.

read

public static VWWorkflowDefinition read(java.io.InputStream theStream)
                                 throws VWException
Evaluates a workflow definition from an input stream. The system creates the new VWWorkflowDefinition using values it reads from the input stream.
Parameters:
theStream - An input stream from which to read the VWWorkflowDefinition object definition.
Returns:
A VWWorkflowDefinition object representing an instance of the data read from the stream specified in the theStream parameter.
Throws:
VWException - Thrown if it cannot evaluate a workflow definition from an input stream.
See Also:
write(java.io.OutputStream)

readFromFile

public static VWWorkflowDefinition readFromFile(java.lang.String theFileName)
                                         throws VWException
Evaluates a workflow definition from a file. The system creates the new VWWorkflowDefinition using values it reads from the named file.
Parameters:
theFileName - The name of the file from which to read the VWWorkflowDefinition object definition.
Returns:
A VWWorkflowDefinition object representing an instance of the data read from the file specified in the theFileName parameter.
Throws:
VWException -  
See Also:
writeToFile(java.lang.String), read(java.io.InputStream)

write

public void write(java.io.OutputStream theStream)
           throws VWException
Writes this VWWorkflowDefinition object to an output stream.
Parameters:
theStream - An object output stream to which to write this workflow definition.
Throws:
VWException - Thrown if it cannot write this VWWorkflowDefinition object to an output stream.
See Also:
read(java.io.InputStream)

writeToFile

public void writeToFile(java.lang.String theFileName)
                 throws VWException
Writes this VWWorkflowDefinition object to a file.
Parameters:
theFileName - Name of the file to which to write this workflow definition.
Throws:
VWException - Thrown if it cannot write this VWWorkflowDefinition object to a file.
See Also:
readFromFile(java.lang.String), write(java.io.OutputStream)

toString

public java.lang.String toString()
Gets the String version of the workflow subject.
Overrides:
toString in class java.lang.Object
Returns:
The subject for the workflow definition.

AsXMLString

public java.lang.String AsXMLString()
                             throws VWException
Retrieves an XML formatted representation of this workflow definition.
Returns:
A String containing a well-formed XML representation of this workflow definition.
Throws:
VWException - Thrown if it cannot retrieve an XML formatted representation of this workflow. definition.
See Also:
write(java.io.OutputStream)

toXML

public void toXML(java.lang.StringBuffer theBuffer)
           throws VWException
Appends an XML String that represents this VWWorkflowDefinition object to the buffer specified by the input parameter.

Warning: This XML String is non-extensible, and cannot be modified in any way.

Parameters:
theBuffer - A String buffer that this method will append with XML content.
Throws:
VWException -  
See Also:
VWXMLUtil

getMilestone

public VWMilestoneDefinition getMilestone(java.lang.String theName)
                                   throws VWException
Gets the definition of a milestone from this workflow definition.
Parameters:
theName - The name of the milestone that the returned definition describes.
Returns:
A VWMilestoneDefinition object that represents the milestone specified in the theName parameter.
Throws:
VWException - Thrown if the system cannot find the milestone specified in the theName parameter.
See Also:
VWMilestoneDefinition

getMilestones

public VWMilestoneDefinition[] getMilestones()
                                      throws VWException
Retrieves the array of milestones for this workflow definition.
Returns:
An array of VWMilestoneDefinitions for this workflow definition. Null means there are no milestones associated with this workflow.
Throws:
VWException - Thrown if there is low-level array access error.

setMilestones

public void setMilestones(VWMilestoneDefinition[] theMilestones)
                   throws VWException
Sets the array of milestones for this workflow definition by reordering but not adding or deleting milestones, with the following Restriction:

The length of the TheMilestones array parameter must be equal to the number of milestones currently in the workflow definition.

Parameters:
theMilestones - An array of VWMilestoneDefinition objects for this workflow definition, whose length equals the number of milestones currently in the workflow definition. Null entries are invalid.
Throws:
VWException - Thrown if the array parameter length is incorrect, if the array contains null entries, or if a low-level array access error occurs.

createMilestone

public VWMilestoneDefinition createMilestone(java.lang.String theName)
                                      throws VWException
Creates a new milestone in this workflow definition.
Parameters:
theName - The name of the new milestone.
Returns:
The newly created milestone definition as a VWMilestoneDefinition.
Throws:
VWException - Thrown if an error occurs creating the milestone.
See Also:
VWMilestoneDefinition

deleteMilestone

public void deleteMilestone(java.lang.String theName)
                     throws VWException
Deletes the specified milestone from this workflow definition.
Parameters:
theName - The name of the milestone to be deleted.
Throws:
VWException - Thrown if an error occurs while deleting the milestone.
See Also:
VWMilestoneDefinition

getAttributeInfo

public VWAttributeInfo getAttributeInfo()
                                 throws VWException
Gets a VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format.
Returns:
A VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format.
See Also:
setAttributeInfo(filenet.vw.api.VWAttributeInfo)

setAttributeInfo

public void setAttributeInfo(VWAttributeInfo theAttributeInfo)
                      throws VWException
Sets a VWAttribute object containing attributes for this object.
Parameters:
theAttributeInfo - A VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format.
Throws:
VWException -  
See Also:
getAttributeInfo()

getRuntimeId

public VWWorkflowRuntimeId getRuntimeId()
Gets the runtime ID for the workflow definition.
Returns:
A VWWorkflowRuntimeId object. Runtime IDs are only valid in workflow definitions that have been transferred to the workflow server and later retrieved.
See Also:
VWSession.transfer

getRuleSets

public VWRuleSetDefinition[] getRuleSets()
                                  throws VWException
Retrieves the array of VWRuleSetDefinition objects for this workflow definition.
Returns:
An array of VWRuleSetDefinitions for this workflow definition. Null means there are no rule sets associated with this workflow.
Throws:
VWException - Thrown if there is low-level array access error.

createRuleSet

public VWRuleSetDefinition createRuleSet(java.lang.String theValue)
                                  throws VWException
Creates a new VWRuleSetDefinition objects in this workflow.
Parameters:
theValue - A String defining the new rule set value.
Returns:
The newly created VWRuleSetDefinition object.
Throws:
VWException -  

deleteRuleSet

public void deleteRuleSet(VWRuleSetDefinition theRuleSet)
                   throws VWException
Deletes a rule set definition from this workflow definition. This method will remove all references to the deleted rule set from the steps in this workflow definition.
Parameters:
theRuleSet - A reference to the VWRuleSetDefinition object to be deleted.
Throws:
VWException -  


Copyright © 2002, 2003 FileNet Corporation. All rights reserved.