|
Process Class Relationships | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--filenet.vw.api.VWWorkflowDefinition
Use this class to create, delete, and access a workflow definition object and its sub-objects.
A workflow definition object represents a business process in a form that supports workflow process authoring for FileNET's IDM WorkFlow products. The workflow definition contains the following data, which the system needs to manage a workflow:
VWMapDefinition
,
VWFieldDefinition
,
VWException
, Serialized FormField Summary | |
static int |
LVALUE
Integer value of 0: this constant can be used to subscript into the pre or post assignment arrays. |
static int |
RVALUE
Integer value of 1: this constant can be used to subscript into the pre or post assignment arrays. |
Constructor Summary | |
VWWorkflowDefinition()
|
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. |
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 a map from this workflow definition using the map name passed to this method to find the map to be deleted. |
void |
deleteMilestone(java.lang.String theName)
Deletes a milestone from this workflow definition using the milestone name passed to this method to find the milestone to be deleted. |
VWAttributeInfo |
getAttributeInfo()
Gets a VWAttribute object containing attributes for this object, as paired labels (keywords) and values in String format. |
java.lang.String |
getBaseWorkClassName()
Gets the value of this workflow definition's base work class name. |
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 the value of this workflow definition's event log name. |
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 a 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 this 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 the value of this workflow definition's roster work class name. |
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 |
setBaseWorkClassName(java.lang.String theBaseWorkClassName)
Changes the value of this workflow definition's base work class name. |
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 this workflow definition's event log name. |
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. |
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 this workflow definition's roster work class name. |
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 |
public static final int LVALUE
public static final int RVALUE
Constructor Detail |
public VWWorkflowDefinition() throws VWException
VWException
- This constructor throws an exception if it
fails.Method Detail |
public VWValidationError[] validate(VWSession theSession, boolean fixupSteps) throws VWException
theSession
- A VWSession object that represents the
session to which the user is currently attached/logged on. An
application needs this object for various parts of the
validation process. The method allows a null input for this
parameter; however, if you pass a null value, the system will
not validate areas that require a logon.
fixupSteps
- A Boolean value. Specify true to set the
joinStepId values for steps that are AND-splits. Specify false
to cause the system not set the join step IDs or, for example,
to cause the system to assume that the caller has already set
the join step Ids.VWException
- public VWFieldDefinition createFieldUsingObject(java.lang.String theName, java.lang.Object theValue) throws VWException
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:
VWException
- VWFieldType
,
VWFieldDefinition
public VWFieldDefinition createFieldUsingString(java.lang.String theName, java.lang.String theValueString, int theType, boolean theIsArray) throws VWException
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
- A Boolean value. Specify true to indicate
that the value expression is to evaluate to an array; otherwise,
specify false.VWException
- VWFieldType
,
VWFieldDefinition
public void deleteField(java.lang.String theName) throws VWException
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.VWException
- Thrown if the
system encounters an error while attempting to delete the field,
or if the system cannot find the specified field.VWFieldDefinition
public VWMapDefinition createMap(java.lang.String theName) throws VWException
theName
- The name of the new map.VWException
- VWMapDefinition
public VWMapDefinition insertMap(VWMapDefinition theMap) throws VWException
theMap
- a map to be inserted into this workflow definition.VWException
- Thrown if
a map with the same name as the map being inserted already
exists in this workflow definition.VWMapDefinition
public VWFieldDefinition insertField(VWFieldDefinition theField) throws VWException
theField
- a field to be inserted into this
workflow definition.VWException
- Thrown if
a field with the same name as the field being inserted already exists in this
workflow definition.VWFieldDefinition
public VWMilestoneDefinition insertMilestone(VWMilestoneDefinition theMilestone) throws VWException
theMilestone
- a milestone to be inserted into this
workflow definition.VWException
- Thrown if
a milestone with the same name as the milestone being inserted
already exists in this workflow definition.VWMilestoneDefinition
public void deleteMap(int theMapId) throws VWException
deleteMap(String)
theMapId
- An integer that contains the ID of the map to
delete.VWException
- IMPORTANT NOTE: Thrown always!VWMapDefinition
public void deleteMap(java.lang.String theMapName) throws VWException
theMapName
- The name of the map to
be deleted.VWException
- Thrown if the
passed map name is "Workflow".VWMapDefinition
public java.lang.String getName()
public void setName(java.lang.String theName) throws VWException
theName
- The name of this workflow
definition. The name cannot begin with a sequence of two tildes ("~~"), because
"~~" is reserved for use in transfer results and is used to distinguish workclass names from
transfer results (VWVersion) when injecting work objects (passed to VWSession.createWorkflow(String)).VWException
- Thrown if the
name specified in the theName parameter is invalid.VWSession.createWorkflow(java.lang.String)
public java.lang.String getBaseWorkClassName()
public void setBaseWorkClassName(java.lang.String theBaseWorkClassName) throws VWException
theBaseWorkClassName
- The new name
of the WorkClass from which this workflow definition will inherit
at transfer/run time.VWException
- Thrown if the
name does not indicate a valid base work class.public java.lang.String getRosterName()
public void setRosterName(java.lang.String theRosterName) throws VWException
theRosterName
- The new name of the
roster that this workflow definition will use at transfer/run time.VWException
- Thrown if the
roster name is invalid.public java.lang.String getEventLogName()
public void setEventLogName(java.lang.String theEventLogName) throws VWException
theEventLogName
- the new name of the event log that this
workflow definition will use at transfer/run timeVWException
- Thrown if the
roster name is invalid.public java.lang.String getTag()
public void setTag(java.lang.String theTag)
theTag
- The new tag expression
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.public java.lang.String getDescription()
public void setDescription(java.lang.String theDescription)
theDescription
- The new description
for this workflow definition.public java.lang.String getMainAttachmentName()
getField(java.lang.String)
,
VWFieldDefinition
,
VWAttachment
public void setMainAttachmentName(java.lang.String theName) throws VWException
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 run time 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.VWException
- Thrown if the
name is not that of a field of type attachment (VWFieldType
.FIELD_TYPE_ATTACHMENT).VWFieldDefinition
,
VWFieldType
public VWFieldDefinition getField(java.lang.String theName) throws VWException
theName
- Name of the field that the returned definition
describes.VWException
- Thrown if the
system cannot find the field specified in the theName parameter.VWFieldDefinition
public VWFieldDefinition[] getFields() throws VWException
VWException
- Thrown if it cannot
get the set of fields associated with this workflow definition.VWFieldDefinition
public VWMapDefinition getMainMap() throws VWException
VWException
- Thrown if the
system cannot get the main map.VWMapDefinition
public VWStepDefinition getLaunchStep() throws VWException
VWException
- Thrown if the
system fails to get the launch step.VWMapDefinition
,
getMainMap()
,
VWMapDefinition.getStartStep()
public java.lang.String getSubject()
public void setSubject(java.lang.String theSubject)
theSubject
- The new value of the
subject property of this workflow definition.
VWWorkflowDefinitionInstance.setSubject("\"my subject\"");
public VWMapDefinition getMap(int theMapId) throws VWException
getMap(String)
.Note getMap(String) takes a map name as a parameter, rather than a Map ID.
theMapId
- An integer representing the ID of the map the
returned definition describes.VWException
- WARNING: An exception is always thrown!VWMapDefinition
public VWMapDefinition getMap(java.lang.String theName) throws VWException
theName
- The name of the workflow
map to retrieve.VWException
- Thrown if the
system cannot find the map with the name specified in the
theName parameter.VWMapDefinition
public VWMapDefinition[] getMaps() throws VWException
VWException
- Thrown if an error
occurs retrieving the maps for this workflow definition.VWMapDefinition
public long getDeadline()
public void setDeadline(long theDeadline) throws VWException
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 run time.
A deadline value of 0 means the workflow has no deadline.Thrown
- if the deadline
value specified in the theDeadline parameter is negative.public long getReminder()
public void setReminder(long theReminder) throws VWException
theReminder
- A positive, long integer specifying the
number of seconds prior to expiration of the deadline timer
that the reminder timer will expire at run time. A reminder
value of 0 (zero) means the step has no reminder.VWException
- Thrown if the
reminder value specified in the theReminder parameter is negative.public static VWWorkflowDefinition read(java.io.InputStream theStream) throws VWException
theStream
- An input stream from which to read the
VWWorkflowDefinition object definition.VWException
- Thrown if it cannot
evaluate a workflow definition from an input stream.write(java.io.OutputStream)
public static VWWorkflowDefinition readFromFile(java.lang.String theFileName) throws VWException
theFileName
- The name of the file
from which to read the VWWorkflowDefinition object definition.VWException
- writeToFile(java.lang.String)
,
read(java.io.InputStream)
public void write(java.io.OutputStream theStream) throws VWException
theStream
- An object output stream to which to write
this workflow definition.VWException
- Thrown if it cannot
write this VWWorkflowDefinition object to an output stream.read(java.io.InputStream)
public void writeToFile(java.lang.String theFileName) throws VWException
theFileName
- Name of the file to which to write this
workflow definition.VWException
- Thrown if it cannot
write this VWWorkflowDefinition object to a file.readFromFile(java.lang.String)
,
write(java.io.OutputStream)
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String AsXMLString() throws VWException
VWException
- Thrown if it cannot
retrieve an XML formatted representation of this workflow.
definition.write(java.io.OutputStream)
public void toXML(java.lang.StringBuffer theBuffer) throws VWException
theBuffer
- A string buffer that this method will append with
XML content.VWException
- VWXMLUtil
public VWMilestoneDefinition getMilestone(java.lang.String theName) throws VWException
theName
- The name of the milestone that
the returned definition describes.VWException
- Thrown if the
system cannot find the milestone specified in the theName
parameter.VWMilestoneDefinition
public VWMilestoneDefinition[] getMilestones() throws VWException
VWException
- Thrown if
there is low-level array access
error.public void setMilestones(VWMilestoneDefinition[] theMilestones) throws VWException
The length of the TheMilestones array parameter must be equal to the number of milestones currently in the workflow definition.
theMilestones
- An array of VWMilestoneDefinition objects for
this workflow definition,lwhose length equals the number of
milestones currently in the workflow definition. Null entries are
invalid.VWException
- Thrown if
the array parameter length is
incorrect, if the array contains null entries or if a low level
array access error occurs.public VWMilestoneDefinition createMilestone(java.lang.String theName) throws VWException
theName
- The name of the new milestone.VWException
- Thrown if
an error occurs creating the milestone.VWMilestoneDefinition
public void deleteMilestone(java.lang.String theName) throws VWException
theName
- The name of the milestone to
be deleted.VWException
- Thrown if
an error occurs while deleting the milestone.VWMilestoneDefinition
public VWAttributeInfo getAttributeInfo() throws VWException
setAttributeInfo(filenet.vw.api.VWAttributeInfo)
public void setAttributeInfo(VWAttributeInfo theAttributeInfo) throws VWException
theAttributeInfo
- A VWAttribute object containing
attributes for this object, as paired labels (keywords) and
values in String format.VWException
- getAttributeInfo()
|
Process Class Relationships | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |