Process Java API: VWWorkflowSignature (Process API Documentation)

java.lang.Object
- filenet.vw.api.VWWorkflowSignature

All Implemented Interfaces:

filenet.vw.base.exprcomp.IFieldCollection, java.io.Serializable
```
public final class VWWorkflowSignature
extends java.lang.Object
implements java.io.Serializable, filenet.vw.base.exprcomp.IFieldCollection
```
This class designates a workflow signature, which represents a work class on the Process Engine after it has been transferred, but before it becomes an executing workflow process.
Retrieve an instance of the workflow signature class with VWSession.fetchWorkflowSignature(String).

Since:

PWWS4.20

See Also:
VWSession.fetchWorkflowSignature(java.lang.String), VWSession.transfer(filenet.vw.api.VWWorkflowDefinition, java.lang.String, boolean, boolean), Serialized Form

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`convertInstructionSheetNameToId(java.lang.String strISheetName)` Converts an instruction sheet name to an instruction sheet ID.
`VWFieldDefinition`	`findField(java.lang.String theFieldName)` Finds a field in this instance.
`java.lang.String`	`getBaseWorkClassName()` Returns the name of the base work class associated with this signature.
`java.lang.String`	`getDescription()` Returns the work class description.
`java.lang.String`	`getEventLogName()` Returns the event log name for the associated work object.
`filenet.vw.base.exprcomp.IField`	`getField(java.lang.String theName)` Reserved for FileNet use.
`VWFieldDefinition[]`	`getFieldDefinitions()` Returns an array of VWFieldDefinition objects that contains the field list.
`java.util.Enumeration`	`getFields()` Reserved for FileNet use.
`java.lang.String`	`getFTagExpression()` Returns the F_Tag expression, which is used for event triggering.
`int`	`getFTagType()` Returns The F_Tag type, which is used for event triggering.
`boolean`	`getHasMyPortType()` Returns `true` if at least one of the partner links in this workflow has a MyPortType property.
`java.lang.String[]`	`getInstructionSheetNames()` Returns the list of instruction sheets for this instance.
`java.lang.String[]`	`getMilestoneNames()` Returns the list of milestones for this instance.
`java.lang.String`	`getName()` Returns the name of the associated work class.
`java.lang.String[]`	`getPartnerlinkNames()` Returns the list of partner links for this instance.
`java.lang.String`	`getRosterName()` Returns the associated workflow definition's roster name.
`java.lang.String[]`	`getRulesetNames()` Returns the list of rule sets for this instance.
`java.lang.String[]`	`getSchemaNames()` Returns the list of schemas for this instance.
`java.util.Date`	`getTransferDateTime()` Returns a date object containing the transfer date/time.
`int`	`getTransferUserId()` Returns the ID of the user who transferred the associated workflow definition.
`java.lang.String`	`getTransferUserName()` Returns the name of the user who transferred the associated workflow definition.
`VWParticipant`	`getTransferUserNamePx()` Returns the participant object for the user who transferred the associated workflow definition.
`boolean`	`getVersionAgnostic()` Returns the version agnostic flag; `true` indicates that Process Engine message correlation does not use the version of the workflow of the received instruction.
`int`	`getWorkspaceId()` Returns the workspace ID.
`boolean`	`isInstructionSheetName(java.lang.String theInstructionSheetName)` Indicates whether the specified instruction sheet is defined for this instance.
`boolean`	`isMilestoneName(java.lang.String theMilestoneName)` Indicates whether the specified milestone is defined for this instance.
`boolean`	`isPartnerlinkName(java.lang.String thePartnerlinkName)` Indicates whether the specified partner link is defined for this instance.
`boolean`	`isRulesetName(java.lang.String theRulesetName)` Indicates whether the specified rule set is defined for this instance.
`boolean`	`isSchemaName(java.lang.String theSchemaName)` Indicates whether the specified schema is defined for this instance.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getTransferUserName
```
public java.lang.String getTransferUserName()
```
    Returns the name of the user who transferred the associated workflow definition.
    
    Returns:
    The transfer user name.
    See Also:
    VWWorkflowDefinition, VWSession.transfer(filenet.vw.api.VWWorkflowDefinition, java.lang.String, boolean, boolean)
  - getTransferUserNamePx
```
public VWParticipant getTransferUserNamePx()
                                    throws VWException
```
    Returns the participant object for the user who transferred the associated workflow definition.
    
    Returns:
    The transfer user name.
    
    Throws:
    
    VWException
  - getRosterName
```
public java.lang.String getRosterName()
```
    Returns the associated workflow definition's roster name. If a translation source exists, the authored roster name is translated.
    Note: The translation is done only at runtime, so will not apply to design-time applications (such as the Process Designer or Configuration Console).
    
    Returns:
    A String containing the translated name of the roster, if a translation source exists; otherwise, the authored name is returned.
  - getName
```
public java.lang.String getName()
```
    Returns the name of the associated work class. If a translation source exists, the authored name is translated.
    Note: The translation is done only at runtime, so will not apply to design-time applications (such as the Process Designer or Configuration Console).
    
    Returns:
    A String containing the translated name of the work class, if a translation source exists; otherwise, the authored name is returned.
  - getHasMyPortType
```
public boolean getHasMyPortType()
```
    Returns true if at least one of the partner links in this workflow has a MyPortType property. The presence of a MyPortType property in a partner link is an indication that the workflow may contain a web service receive instruction, since this property is normally used by a receive instruction.
    
    Returns:
    true if at least one of the partner links in this workflow has a MyPortType property.
    See Also:
    VWReceiveInstruction
  - getVersionAgnostic
```
public boolean getVersionAgnostic()
```
    Returns the version agnostic flag; true indicates that Process Engine message correlation does not use the version of the workflow of the received instruction.
    
    Returns:
    Version agnostic flag value; true indicates that Process Engine message correlation does not use the version of the workflow of the received instruction.
    See Also:
    VWWorkflowDefinition.setVersionAgnostic( boolean ), Business Process Execution Language for Web Services Version 1.1, Message Properties
  - getWorkspaceId
```
public int getWorkspaceId()
```
    Returns the workspace ID.
    
    Returns:
    The workspace ID
  - getEventLogName
```
public java.lang.String getEventLogName()
```
    Returns the event log name for the associated work object. If a translation source exists, the authored name is translated.
    Note: The translation is done only at runtime, so will not apply to design-time applications (such as the Process Designer or Configuration Console).
    
    Returns:
    A String containing the translated name of the event log, if a translation source exists; otherwise, the authored name is returned.
    See Also:
    VWWorkflowDefinition.setEventLogName
  - getDescription
```
public java.lang.String getDescription()
```
    Returns the work class description. If a translation source exists, the authored description is translated.
    Note: The translation is done only at runtime, so will not apply to design-time applications (such as the Process Designer or Configuration Console).
    
    Returns:
    A String containing the translated description of the work class, if a translation source exists; otherwise, the authored description is returned.
  - getTransferUserId
```
public int getTransferUserId()
```
    Returns the ID of the user who transferred the associated workflow definition.
    
    Returns:
    The ID of the user who transferred the associated workflow definition
  - getTransferDateTime
```
public java.util.Date getTransferDateTime()
```
    Returns a date object containing the transfer date/time.
    
    Returns:
    A date object containing the transfer date/time
  - getFTagExpression
```
public java.lang.String getFTagExpression()
```
    Returns the F_Tag expression, which is used for event triggering.
    
    Returns:
    The F_Tag expression.
    See Also:
    VWWFEInstruction.createEvent()
  - getFTagType
```
public int getFTagType()
```
    Returns The F_Tag type, which is used for event triggering.
    
    Returns:
    The F_Tag type.
    See Also:
    VWWFEInstruction.createEvent()
  - getFieldDefinitions
```
public VWFieldDefinition[] getFieldDefinitions()
```
    Returns an array of VWFieldDefinition objects that contains the field list.
    
    Returns:
    An array of VWFieldDefinition objects that contains the field list.
  - getInstructionSheetNames
```
public java.lang.String[] getInstructionSheetNames()
```
    Returns the list of instruction sheets for this instance. If a translation source exists, the authored instruction sheet names are translated.
    Note: The translation is done only at runtime, so will not apply to design-time applications (such as the Process Designer or Configuration Console).
    
    Returns:
    A String array containing the translated names of the instruction sheets, if a translation source exists; otherwise, the authored names are returned..
  - isInstructionSheetName
```
public boolean isInstructionSheetName(java.lang.String theInstructionSheetName)
```
    Indicates whether the specified instruction sheet is defined for this instance.
    
    Parameters:
    theInstructionSheetName - A String containing the name of the instruction sheet. If a translation source exists, the authored name is translated.
    Note: The translation is done only at runtime, so will not apply to design-time applications (such as the Process Designer or Configuration Console).
    
    Returns:
    A boolean value of true if the specified instruction sheet is found in the list of instruction sheet names for this instance; otherwise, false.
  - findField
```
public VWFieldDefinition findField(java.lang.String theFieldName)
```
    Finds a field in this instance.
    
    Parameters:
    theFieldName - A String containing the name of the field. If a translation source exists, the authored name is translated.
    Note: The translation is done only at runtime, so will not apply to design-time applications (such as the Process Designer or Configuration Console).
    
    Returns:
    The VWFieldDefinition object for the specified field, or null if the field is not found.
  - getField
```
public filenet.vw.base.exprcomp.IField getField(java.lang.String theName)
                                         throws java.lang.Exception
```
    Reserved for FileNet use. Do not use.
    
    Specified by:
    
    getField in interface filenet.vw.base.exprcomp.IFieldCollection
    
    Throws:
    
    java.lang.Exception
  - getFields
```
public java.util.Enumeration getFields()
                                throws java.lang.Exception
```
    Reserved for FileNet use. Do not use.
    
    Specified by:
    
    getFields in interface filenet.vw.base.exprcomp.IFieldCollection
    
    Throws:
    
    java.lang.Exception
  - convertInstructionSheetNameToId
```
public int convertInstructionSheetNameToId(java.lang.String strISheetName)
                                    throws VWException
```
    Converts an instruction sheet name to an instruction sheet ID.
    
    Parameters:
    strISheetName - A String containing the name of the instruction sheet to convert to an instruction sheet ID. If a translation source exists, the authored name is translated.
    Note: The translation is done only at runtime, so will not apply to design-time applications (such as the Process Designer or Configuration Console).
    
    Returns:
    An integer indicating the workflow ID for the specified instruction sheet.
    
    Throws:
    
    VWException - Various causes, including when an instruction sheet ID was not found.
    Since:
    
    eP6.0
  - getMilestoneNames
```
public java.lang.String[] getMilestoneNames()
```
    Returns the list of milestones for this instance. If a translation source exists, the authored milestone names are translated.
    Note: The translation is done only at runtime, so will not apply to design-time applications (such as the Process Designer or Configuration Console).
    
    Returns:
    A String array containing the translated names of the milestones, if a translation source exists; otherwise, the authored names are returned.
  - isMilestoneName
```
public boolean isMilestoneName(java.lang.String theMilestoneName)
```
    Indicates whether the specified milestone is defined for this instance.
    
    Parameters:
    theMilestoneName - A String containing the name of the milestone. If a translation source exists, the authored name is translated.
    Note: The translation is done only at runtime, so will not apply to design-time applications (such as the Process Designer or Configuration Console).
    
    Returns:
    A boolean value of true if the specified milestone is found in the list of milestone names for this instance; otherwise, false.
  - getRulesetNames
```
public java.lang.String[] getRulesetNames()
```
    Returns the list of rule sets for this instance. If a translation source exists, the authored names of the rule sets are translated.
    Note: The translation is done only at runtime, so will not apply to design-time applications (such as the Process Designer or Configuration Console).
    
    Returns:
    A String array containing the translated names of the rule sets, if a translation source exists; otherwise, the authored names are returned.
  - isRulesetName
```
public boolean isRulesetName(java.lang.String theRulesetName)
```
    Indicates whether the specified rule set is defined for this instance.
    
    Parameters:
    theRulesetName - A String containing the name of the rule set. If a translation source exists, the authored name is translated.
    Note: The translation is done only at runtime, so will not apply to design-time applications (such as the Process Designer or Configuration Console).
    
    Returns:
    A boolean value of true if the specified rule set is found in the list of rule set names for this instance; otherwise, false.
  - getPartnerlinkNames
```
public java.lang.String[] getPartnerlinkNames()
```
    Returns the list of partner links for this instance. If a translation source exists, the authored names of the partner links are translated.
    Note: The translation is done only at runtime, so will not apply to design-time applications (such as the Process Designer or Configuration Console).
    
    Returns:
    A String array containing the translated names of the partner links, if a translation source exists; otherwise, the authored names are returned.
  - isPartnerlinkName
```
public boolean isPartnerlinkName(java.lang.String thePartnerlinkName)
```
    Indicates whether the specified partner link is defined for this instance.
    
    Parameters:
    thePartnerlinkName - A String containing the name of the partner link. If a translation source exists, the authored name is translated.
    Note: The translation is done only at runtime, so will not apply to design-time applications (such as the Process Designer or Configuration Console).
    
    Returns:
    A boolean value of true if the specified partner link is found in the list of partner link names for this instance; otherwise, false.
  - getSchemaNames
```
public java.lang.String[] getSchemaNames()
```
    Returns the list of schemas for this instance. If a translation source exists, the authored names of the schemas are translated.
    Note: The translation is done only at runtime, so will not apply to design-time applications (such as the Process Designer or Configuration Console).
    
    Returns:
    A String array containing the translated names of the schemas, if a translation source exists; otherwise, the authored names are returned.
  - isSchemaName
```
public boolean isSchemaName(java.lang.String theSchemaName)
```
    Indicates whether the specified schema is defined for this instance.
    
    Parameters:
    theSchemaName - A String containing the name of the schema. If a translation source exists, the authored name is translated.
    Note: The translation is done only at runtime, so will not apply to design-time applications (such as the Process Designer or Configuration Console).
    
    Returns:
    A boolean value of true if the specified schema is found in the list of schema names for this instance; otherwise, false.
  - getBaseWorkClassName
```
public java.lang.String getBaseWorkClassName()
```
    Returns the name of the base work class associated with this signature. If a translation source exists, the authored name is translated.
    Note: The translation is done only at runtime, so will not apply to design-time applications (such as the Process Designer or Configuration Console).
    
    Returns:
    A String containing the translated name of the base work class, if a translation source exists; otherwise, the authored name is returned.

Methods inherited from class java.lang.Object

getTransferUserName

getTransferUserNamePx

getRosterName

getName

getHasMyPortType

getVersionAgnostic

getWorkspaceId

getEventLogName

getDescription

getTransferUserId

getTransferDateTime

getFTagExpression

getFTagType

getFieldDefinitions

getInstructionSheetNames

isInstructionSheetName

findField

getField

getFields

convertInstructionSheetNameToId

getMilestoneNames

isMilestoneName

getRulesetNames

isRulesetName

getPartnerlinkNames

isPartnerlinkName

getSchemaNames

isSchemaName

getBaseWorkClassName