|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWWorkflowDefinition
public final class VWWorkflowDefinition
Use this class to create, delete, and access a workflow and its sub-objects. A workflow definition is the basis of an authored workflow and includes a user-created graphical map showing the sequences, resources, and routing logic of the specific steps needed to complete the workflow process.
A workflow can be persisted by saving a workflow definition object to a file.
VWMapDefinition
,
VWFieldDefinition
,
VWException
,
Serialized FormField Summary | |
---|---|
static int |
LVALUE
Value of 0: A subscript for the pre or post assignment arrays. |
static int |
RVALUE
Value of 1: A subscript for the pre or post assignment arrays. |
Constructor Summary | |
---|---|
VWWorkflowDefinition()
Creates a VWWorkflowDefinition instance. |
Method Summary | |
---|---|
static java.lang.String |
_get_FILE_AUTHOR()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_DATE()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_REVISION()
For FileNet internal use only, do not call. |
java.lang.String |
AsXMLString()
Retrieves an XML-formatted representation of this workflow definition. |
java.lang.Object |
clone()
Creates a clone of this VWWorkflowDefinition object. |
void |
convertAllRouteConditionsToValidExpressions()
Converts the route conditions for each route in this workflow definition to the standard syntax format: Expressions containing "ALL", "NONE", "ANY" or "COUNT" are converted to expressions using the F_Responses and F_ResponseCount fields. |
VWFieldDefinition |
createFieldUsingObject(java.lang.String theName,
java.lang.Object theValue)
Deprecated. Replaced by createFieldUsingString(String, String, int, boolean) |
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. |
VWPartnerLinkDefinition |
createPartnerLink(java.lang.String theName)
Creates a new partner link in this workflow definition. |
VWRuleSetDefinition |
createRuleSet(java.lang.String theValue)
Creates a new rule set (VWRuleSetDefinition object) in this workflow. |
VWSchema |
createSchema(java.lang.String theName)
Creates a new schema 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 the specified map from this workflow definition. |
void |
deleteMilestone(java.lang.String theName)
Deletes the specified milestone from this workflow definition. |
void |
deletePartnerLink(java.lang.String theName)
Deletes the specified partner link from this workflow definition. |
void |
deleteRuleSet(java.lang.String theRuleSetName)
Deletes the specified rule set definition from this instance, removing all references to the rule set from the workflow definition steps. |
void |
deleteRuleSet(VWRuleSetDefinition theRuleSet)
Deprecated. Use public void deleteRuleSet(String theRuleSetName) instead. Changes in the API to support inheriting rulessets make it is no longer possible to support deleting rulesets by reference. Rulesets should be deleted by name. This method calls deleteRuleSet(theRuleSet.getName()). |
void |
deleteSchema(java.lang.String theName)
Deletes the specified schema 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 this workflow definition's base work class name. |
long |
getDeadline()
Retrieves the deadline property for this workflow definition. |
java.lang.String |
getDescription()
Gets the description property of this workflow definition. |
boolean |
getDisableEmailNotification()
Gets the workflow's disable email notification property. |
java.lang.String |
getEventLogName()
Gets the name of this workflow definition's event log. |
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. |
VWWorkflowDefinition |
getFlattenedCopy(VWSession theSession)
Returns a copy of this workflow that includes attributes inherited from the parent workflow. |
java.lang.String |
getIncomingWSAttachmentFolder()
Gets the String representation for an attachment that specifies a folder for storing incoming Web Services attachments that are available through a receive instruction. |
VWStepDefinition |
getLaunchStep()
Gets 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 main map for 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 based on the specified map name. |
int |
getMapIndex(java.lang.String theName)
Returns the index of the specified workflow map associated with this workflow definition. |
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()
Returns the milestones for this workflow definition. |
java.lang.String |
getName()
Gets the name property for this workflow definition. |
VWPartnerLinkDefinition |
getPartnerLink(java.lang.String theName)
Gets the definition of a partner link from this workflow definition. |
VWPartnerLinkDefinition[] |
getPartnerLinks()
Retrieves all of the partner links for this workflow definition. |
long |
getReminder()
Retrieves the reminder property for this workflow definition. |
java.lang.String |
getRosterName()
Gets this workflow definition's roster name. |
VWRuleSetDefinition[] |
getRuleSets()
Retrieves the rule sets for this workflow definition. |
VWWorkflowRuntimeId |
getRuntimeId()
Gets the runtime ID for the workflow definition. |
VWSchema |
getSchema(java.lang.String theName)
Gets the specified schema for this workflow definition. |
VWSchema[] |
getSchemas()
Retrieves the schemas for this workflow definition. |
java.lang.String |
getSubject()
Gets the subject of this workflow definition (the value of the F_Subject system field). |
java.lang.String |
getTag()
Gets the tag expression of this workflow definition. |
boolean |
getTransferFlag()
Returns the value of the transfer flag for this workflow definition. |
boolean |
getValidateFlag()
Returns the value of the validate flag for this workflow definition. |
boolean |
getValidateUsingSchema()
Indicates process orchestration messages are validated (at runtime) using the appropriate schema. |
boolean |
getVersionAgnostic()
Returns the value of the versionAgnostic flag set for this workflow definition. |
VWWorkflowSignature |
getWorkflowSignature()
(FileNet internal use only) Return a work class signature for 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. |
VWPartnerLinkDefinition |
insertPartnerLink(VWPartnerLinkDefinition thePartnerLink)
Inserts a partner link in this workflow definition. |
VWRuleSetDefinition |
insertRuleSet(VWRuleSetDefinition theRuleSet)
Inserts a ruleset in this workflow definition. |
VWSchema |
insertSchema(VWSchema theSchema)
Inserts a schema 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. |
void |
setDeadline(long theDeadline)
Changes the deadline property for this workflow definition. |
void |
setDescription(java.lang.String theDescription)
Changes the description property of this workflow definition. |
void |
setDisableEmailNotification(boolean bFlag)
Sets the workflow's disable email notification property. |
void |
setEventLogName(java.lang.String theEventLogName)
Changes the event log name for this workflow definition. |
void |
setIncomingWSAttachmentFolder(java.lang.String inAttachmentFolder)
Specifies a folder that will be used to store incoming Web Services attachments that are available through a receive instruction. |
void |
setMainAttachmentName(java.lang.String theName)
Modifies the main attachment name property of this workflow definition. |
void |
setMilestones(VWMilestoneDefinition[] theMilestones)
Replaces or reorders the array of milestones for this workflow definition, without adding or deleting milestones. |
void |
setName(java.lang.String theName)
Changes the name property for this workflow definition. |
void |
setPartnerLinks(VWPartnerLinkDefinition[] ThePartnerLinks)
Replaces or reorders the array of partner links for this workflow definition, without adding or deleting partner links. |
void |
setReminder(long theReminder)
Changes the reminder property for this workflow definition. |
void |
setRosterName(java.lang.String theRosterName)
Changes the roster name for this workflow definition. |
void |
setSchemas(VWSchema[] TheSchemas)
Replaces or reorders the array of schemas for this workflow definition, without adding or deleting schemas. |
void |
setSubject(java.lang.String theSubject)
Modifies the subject property of this workflow definition. |
void |
setTag(java.lang.String theTag)
Changes the tag property of this workflow definition. |
void |
setTransferFlag(boolean theTransferFlag)
Sets the transfer flag for this workflow definition. |
void |
setValidateFlag(boolean theValidateFlag)
Sets the validate flag for this workflow definition. |
void |
setValidateUsingSchema(boolean theValidateUsingSchemaFlag)
Determines whether process orchestration messages are to be validated (at runtime) using the appropriate schema. |
void |
setVersionAgnostic(boolean theAgnosticFlag)
Determines whether or not the workflow revision for the received instruction (the value of the F_WorkClassRevision field) is one of the selection criteria used to match the correct work item. |
java.lang.String |
toString()
Gets a String representation of this instance. |
void |
toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
toXPDL(java.lang.String indentA,
java.lang.StringBuffer theBuffer)
Appends an XPDL string representing this instance to the buffer specified. |
VWValidationError[] |
validate(VWSession theSession,
boolean fixupSteps)
Validates this instance. |
void |
write(java.io.OutputStream theStream)
Writes this instance to an output stream. |
void |
writeToFile(java.lang.String theFileName)
Writes this instance 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
Method Detail |
---|
public static java.lang.String _get_FILE_DATE()
public static java.lang.String _get_FILE_AUTHOR()
public static java.lang.String _get_FILE_REVISION()
public VWValidationError[] validate(VWSession theSession, boolean fixupSteps) throws VWException
When looking for the base workflow signature during validation, the workflow collection is searched
first because this is what a transfer will use. If the base workflow does not exist in the collection,
it is retrieved from the server. If the base workflow does exist in the collection, but it does not
have the transfer flag set (see setTransferFlag
, a validation warning will occur.
theSession
- The current VWSession object if logged on. This is needed
for various parts of the validation process. This can be null; however, areas of validation requiring a
logon will not be validated.fixupSteps
- A boolean value of true to indicate that the step ID values for joins (steps that are AND'd)
are to be filled in. Specify false if you do not want the step IDs to be filled in for the join, or to
indicate that the caller has already specified the join step IDs.
VWException
- Thrown if an error occurs during validation.public VWFieldDefinition createFieldUsingObject(java.lang.String theName, java.lang.Object theValue) throws VWException
createFieldUsingString(String, String, int, boolean)
theName
- Name of the field to create.theValue
- An object containing the value to place in the
newly created field. The type must be a single value (object)
or an array of one of the field types defined for the
VWFieldType
class.
VWException
VWFieldType
,
VWFieldDefinition
public VWFieldDefinition createFieldUsingString(java.lang.String theName, java.lang.String theValueString, int theType, boolean theIsArray) throws VWException
theName
- Name of the field to create.
theValueString
- 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.
VWException
VWFieldType
,
VWFieldDefinition
public void deleteField(java.lang.String theName) throws VWException
theName
- 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
- 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 VWRuleSetDefinition insertRuleSet(VWRuleSetDefinition theRuleSet) throws VWException
theRuleset
- A ruleset to be inserted into this
workflow definition.
VWException
- Thrown for various causes, including when
a ruleset with the same value as the ruleset being inserted
already exists in this workflow definition.VWRuleSetDefinition
public VWPartnerLinkDefinition insertPartnerLink(VWPartnerLinkDefinition thePartnerLink) throws VWException
thePartnerLink
- A partner link to be inserted into this
workflow definition.
VWException
- Thrown for various causes, including when
a partner link with the same name as the partner link being inserted
already exists in this workflow definition.VWPartnerLinkDefinition
public VWSchema insertSchema(VWSchema theSchema) throws VWException
theschema
- A schema to be inserted into this
workflow definition.
VWException
VWSchema
public void deleteMap(int theMapId) throws VWException
deleteMap(String)
theMapId
- An integer that contains the ID of the map to
delete.
VWException
- Note Always thrown.VWMapDefinition
public void deleteMap(java.lang.String theMapName) throws VWException
theMapName
- Name of the map to be deleted.
VWException
- Thrown , for example, if the input
map name is "Workflow".VWMapDefinition
public java.lang.String getName()
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
setName
public void setName(java.lang.String theName) throws VWException
theName
- Name of this workflow
definition. The name cannot begin with a
tilde ('~') character, because this denotes a name that is
reserved for internal use. The name cannot be null.
VWException
- Thrown for various causes, including when
theName parameter begins with a tilde ('~') character, or the name is null.public java.lang.String getBaseWorkClassName()
setBaseWorkClassName
.
If a translation source exists, the authored work class name is translated.
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
public void setBaseWorkClassName(java.lang.String theBaseWorkClassName) throws VWException
theBaseWorkClassName
- A String containing the new name
of the work class from which this workflow definition will inherit
upon transfer or initialization.
VWException
- Thrown if the
name does not indicate a valid base work class.public java.lang.String getRosterName()
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
setRosterName
,
getBaseWorkClassName
public void setRosterName(java.lang.String theRosterName) throws VWException
theRosterName
- Roster name for this workflow definition, or null.
Null causes the associated roster to inherit its name
property from the roster name property of the base work class,
when the roster is transferred or initialized.
VWException
- Thrown if the roster name is invalid.getBaseWorkClassName()
public java.lang.String getEventLogName()
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
setEventLogName
public void setEventLogName(java.lang.String theEventLogName) throws VWException
theEventLogName
- Name of the event log that this
workflow definition uses during transfer or initialization
processes, or null. Null is returned when the event log name property
will be inherited from the base work class.
VWException
- Thrown if the event log name is invalid.public java.lang.String getAuthorTool()
public void setAuthorTool(java.lang.String theAuthorTool) throws VWException
theAuthorTool
- New authorTool property value for this
workflow definition.
VWException
public java.lang.String getTag()
public void setTag(java.lang.String theTag)
theTag
- 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.public java.lang.String getDescription()
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
public void setDescription(java.lang.String theDescription)
theDescription
- New description
for this workflow definition.public java.lang.String getMainAttachmentName()
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
Pass the returned name to getField(String)
getField to get the VWFieldDefinition
object this attachment.
VWFieldDefinition
,
VWAttachment
public void setMainAttachmentName(java.lang.String theName) throws VWException
theName
- 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.
VWException
- Thrown if the theName parameter is not a quoted String.VWFieldDefinition
,
VWFieldType
public VWFieldDefinition getField(java.lang.String theName) throws VWException
theName
- A String containing the name of the field. If a translation source exists,
the authored field name is translated.
VWException
- Thrown if the specified data field cannot be found.VWFieldDefinition
public VWFieldDefinition[] getFields() throws VWException
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
VWException
- Thrown if the set of fields associated with this instance cannot be
retrieved.VWFieldDefinition
public VWMapDefinition getMainMap() throws VWException
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
VWException
- Thrown if the main map cannot be retrieved.VWMapDefinition
public VWStepDefinition getLaunchStep() throws VWException
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
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.
VWException
- Thrown if the launch step cannot be retrieved.VWMapDefinition
,
getMainMap
,
VWMapDefinition.getStartStep
public java.lang.String getSubject()
public void setSubject(java.lang.String theSubject)
theSubject
- 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!public VWMapDefinition getMap(java.lang.String theName) throws VWException
theName
- A String containing the name of the workflow map to retrieve.
If a translation source exists, the authored map name is translated.
VWException
- Thrown if the specified map cannot be found.VWMapDefinition
public int getMapIndex(java.lang.String theName) throws VWException
theName
- A String containing the name of the workflow map.
VWException
- Thrown if the named map cannot be found.VWMapDefinition
public VWMapDefinition[] getMaps() throws VWException
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
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 either 0
(zero) or the
number of minutes between launching of the workflow and the
expiration of the workflow's deadline timer at runtime.
0 (zero) signifies the workflow has no deadline.
VWException
- Thrown for various causes, including when
the value specified in the theDeadline parameter is invalid.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 runtime, or 0 (zero).
0 (zero) signifies the step has no reminder.
VWException
- Thrown for various causes, including when the
reminder value specified in the theReminder parameter is invalid.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
- 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 OutputStream object to which to write this instance.
VWException
- Thrown if this instance is unable to be written to the output stream specified.read(InputStream)
public void writeToFile(java.lang.String theFileName) throws VWException
theFileName
- A String containing the name of the file to which to write this instance.
VWException
- Thrown if this instance cannot be written to the specified file.readFromFile
,
write(OutputStream)
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String AsXMLString() throws VWException
VWException
- Thrown if this method cannot
retrieve an XML formatted representation of this workflow
definition.write(java.io.OutputStream)
public void toXML(java.lang.StringBuffer theBuffer) throws VWException
Warning: This XML string is nonextensible, and cannot be modified in any way.
theBuffer
- A StringBuffer that will be appended with the XML content.
VWException
- Thrown if the specified buffer is null.VWXMLUtil
public void toXPDL(java.lang.String indentA, java.lang.StringBuffer theBuffer) throws VWException
Warning: This XPDL string is nonextensible, and cannot be modified in any way.
indentA
- A String specifying the initial indentation for this XPDL section.theBuffer
- A StringBuffer that will be appended with the XPDL content.
VWException
- Thrown if the specified buffer is null.VWXMLUtil
public VWMilestoneDefinition getMilestone(java.lang.String theName) throws VWException
theName
- A String containing the name of the milestone.
If a translation source exists, the authored milestone name is translated.
VWException
- Thrown if the milestone specified cannot be found.VWMilestoneDefinition
public VWMilestoneDefinition[] getMilestones() throws VWException
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
VWException
public void setMilestones(VWMilestoneDefinition[] theMilestones) throws VWException
theMilestones
- An array of VWMilestoneDefinition objects for
this workflow definition, whose length equals the current number of
milestones in the workflow definition. Null entries are
invalid.
VWException
- Thrown for various causes, including when
the array input parameter is invalid.public VWMilestoneDefinition createMilestone(java.lang.String theName) throws VWException
theName
- Name of the new milestone.
VWException
VWMilestoneDefinition
public void deleteMilestone(java.lang.String theName) throws VWException
theName
- Name of the milestone to be deleted.
VWException
- Thrown if
an error occurs while deleting the milestone.VWMilestoneDefinition
public VWPartnerLinkDefinition createPartnerLink(java.lang.String theName) throws VWException
theName
- name for this partner link. Name must be
non-null and non-zero length, and must not
match an existing partner link name. The length of the partner
link name must not exceed 15 characters. Partner link names can only contain letters
numbers and underscores.
VWException
VWPartnerLinkDefinition
public void deletePartnerLink(java.lang.String theName) throws VWException
theName
- Name of the partner link to be deleted.
VWException
- Thrown for various causes, including when
the named partner link cannot be found.VWPartnerLinkDefinition
public VWPartnerLinkDefinition getPartnerLink(java.lang.String theName) throws VWException
theName
- A String containing the name of the partner link for instance.
If a translation source exists, the authored partner link name is translated.
VWException
- Thrown for various causes, including
when the specified partner link cannot be found.VWPartnerLinkDefinition
public VWSchema createSchema(java.lang.String theName) throws VWException
theName
- Name of the new schema.
VWException
VWSchema
public void deleteSchema(java.lang.String theName) throws VWException
theName
- Name of the schema to be deleted.
VWException
- Thrown for various causes, including when
the named schema cannot be found.VWSchema
public VWSchema getSchema(java.lang.String theName) throws VWException
theName
- A String containing the name of the schema. If a translation source exists,
the authored schema name is translated.
VWException
- Thrown for various causes, including when
the specified schema cannot be found.VWSchema
public VWPartnerLinkDefinition[] getPartnerLinks() throws VWException
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
VWException
public VWSchema[] getSchemas() throws VWException
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
VWException
public void setPartnerLinks(VWPartnerLinkDefinition[] ThePartnerLinks) throws VWException
ThePartnerLinks
- An array of non-null VWPartnerLinkDefinition
objects for this workflow definition, whose length equals
the current number of partner links in the workflow definition.
VWException
- Thrown for various causes, including when
the array input parameter is invalid.public void setSchemas(VWSchema[] TheSchemas) throws VWException
TheSchemas
- An array of non-null VWSchema objects for
this workflow definition, whose length equals the current number of
schemas in the workflow definition.
VWException
- Thrown for various causes, including when
the array input parameter is invalid.public VWWorkflowSignature getWorkflowSignature() throws VWException
Return a work class signature for this workflow definition. The validate operation needs to look up field definitions in a work class or an alternate work class. Usually the alternate work class will be fetched from the server as a VWWorkflowSignature object. This method formats this workflow definition instance as a VWWorkflowSignature object to make the validation field lookup operation simpler.
Note: Some members of the returned VWWorkflowSignature object (those that would normally be filled in during transfer) will be null or otherwise invalid. In this case, the VWWorkflowSignature object obtained is not guaranteed to be exactly the same as a signature for this workflow obtained from the server after transfer using VWSession.fetchWorkflowSignature.
VWException
public VWAttributeInfo getAttributeInfo() throws VWException
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.
VWException
getAttributeInfo()
public VWWorkflowRuntimeId getRuntimeId()
public boolean getDisableEmailNotification()
true
if email notification is disabled
for this workflow; false
otherwise.public void setDisableEmailNotification(boolean bFlag)
bFlag
- true
specifies email notification is disabled
for this workflow; false
specifies otherwise.public VWRuleSetDefinition[] getRuleSets() throws VWException
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
VWException
public VWRuleSetDefinition createRuleSet(java.lang.String theValue) throws VWException
theValue
- A String defining the new rule set value.
VWException
public void deleteRuleSet(VWRuleSetDefinition theRuleSet) throws VWException
theRuleSet
- the rule set to delete
VWException
public void deleteRuleSet(java.lang.String theRuleSetName) throws VWException
theRuleSetName
- A String containing the name of the VWRuleSetDefinition object to be deleted.
VWException
- Thrown if the parameter is null or the specified name cannot be found.public void setIncomingWSAttachmentFolder(java.lang.String inAttachmentFolder) throws VWException
inAttachmentFolder
- A String formatted as the VWAttachment.toString
form
of a VWAttachment object having an attachment type of
VWAttachmentType.ATTACHMENT_TYPE_FOLDER
.
VWException
VWAttachment
,
VWAttachmentType
public java.lang.String getIncomingWSAttachmentFolder()
VWAttachment
,
VWAttachmentType
public void setVersionAgnostic(boolean theAgnosticFlag)
theAgnosticFlag
- A boolean value of true (the default) to perform message correlation without using
the workflow revision. Specify false if the received message will not change format and can be received by
any revision of the workflow. Workflow revision will then be used as one of the selection criteria to find
the correct work item.public boolean getVersionAgnostic()
setVersionAgnostic
public void setValidateUsingSchema(boolean theValidateUsingSchemaFlag)
theValidateUsingSchemaFlag
- A boolean value of true to validate process orchestration messages at runtime
using the appropriate schema; otherwise, false.public boolean getValidateUsingSchema()
setValidateUsingSchema
public void setValidateFlag(boolean theValidateFlag)
theValidateFlag
- A boolean value of true indicates that when
VWWorkflowCollectionDefinition.validate
is invoked on the VWWorkflowCollectionDefinition object containing this instance, the
validate
method is called to validate this workflow. If false, this
instance is not validated when VWWorkflowCollectionDefinition.validate is invoked.VWWorkflowCollectionDefinition
public boolean getValidateFlag()
VWWorkflowCollectionDefinition.validate
is invoked on the VWWorkflowCollectionDefinition object containing this instance, the
validate
method is called to validate this workflow. If false, this
instance is not validated when VWWorkflowCollectionDefinition.validate is invoked.setValidateFlag( boolean )
,
VWWorkflowCollectionDefinition
public void setTransferFlag(boolean theTransferFlag)
theValidateFlag
- A boolean value of true indicates that
transferring a VWWorkflowCollectionDefinition containing this
VWWorkflowDefinition will transfer this workflow. A value of false indicates
this workflow will not be transferred if a VWWorkflowCollectionDefinition
containing this VWWorkflowDefinition is transferred.VWWorkflowCollectionDefinition
public boolean getTransferFlag()
setTransferFlag( boolean )
,
VWWorkflowCollectionDefinition
public java.lang.Object clone()
clone
in class java.lang.Object
public void convertAllRouteConditionsToValidExpressions() throws VWException
Warning: Calling this method permanently changes all route condition expressions in this workflow definition to a less user-friendly form. For example, an expression that checked whether all participants in a step chose the response "YES", would change from "ALL(YES)" to "F_Responses[1] = F_ResponseCount" (in this case, assuming 1 is the index of the "YES" response in the F_Responses array). The only way to revert the change is to reread the PEP file containing the original route conditions, which may cause the loss of other changes.
VWException
public VWWorkflowDefinition getFlattenedCopy(VWSession theSession) throws VWException
Inherited attributes are maps, fields, rule sets, milestones, schemas and partnerlinks. Attributes from this (child) workflow definition override attributes of the same name and type inherited from the parent workflow definition.
The name of the flattened copy will be the result of the espression ' this.getName() + "_FLATTENED" '. The base work class name of the flattened copy will be "WorkObjectEx".
theSession
- The VWSession object that will be used to retrieve the parent workflow definition
from the Process Engine server.
VWException
- if an error occurs, for example if the parent
workflow is not found on the server.
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |