Process Class Relationships

filenet.vw.api
Class VWWorkflowSignature

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 after it is transferred and compiled, but before it becomes an executing workflow process. It represents a workclass on the server before the workclass is instantiated.

Retrieve the workflow signature class with VWSession.fetchWorkflowSignature(String).

Since:
PWWS4.20
See Also:
VWSession.fetchWorkflowSignature(java.lang.String), Serialized Form

Method Summary
 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 definition in the list of field definitions in this VWWorkflowSignature.
 java.lang.String getEventLogName()
          Returns the event log name.
 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 a string that is the F_Tag expression.
 int getFTagType()
          Returns an integer that is the F_Tag type.
 java.lang.String[] getInstructionSheetNames()
          Returns an array of strings that holds the instruction sheet names list.
 java.lang.String getRosterName()
          Returns the roster name.
 java.util.Date getTransferDateTime()
          Returns a date that holds the transfer date/time.
 int getTransferUserId()
          Returns an integer that is the transfer user Id.
 java.lang.String getTransferUserName()
          Returns the transfer user name.
 boolean isInstructionSheetName(java.lang.String theInstructionSheetName)
          Checks for the existence of a named instruction sheet in this VWWorkflowSignature's list of instruction sheet names.
 
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 transfer user name.
Returns:
The transfer user name.

getRosterName

public java.lang.String getRosterName()
Returns the roster name.
Returns:
The roster name.

getEventLogName

public java.lang.String getEventLogName()
Returns the event log name.
Returns:
The event log name.

getTransferUserId

public int getTransferUserId()
Returns an integer that is the transfer user Id.
Returns:
An integer that is the transfer user Id.

getTransferDateTime

public java.util.Date getTransferDateTime()
Returns a date that holds the transfer date/time.
Returns:
A date that holds the transfer date/time.

getFTagExpression

public java.lang.String getFTagExpression()
Returns a string that is the F_Tag expression.
Returns:
A string that is the F_Tag expression.

getFTagType

public int getFTagType()
Returns an integer that is the F_Tag type.
Returns:
An integer that is the F_Tag type.

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 an array of strings that holds the instruction sheet names list.
Returns:
An array of strings that holds the instruction sheet names list.

isInstructionSheetName

public boolean isInstructionSheetName(java.lang.String theInstructionSheetName)
Checks for the existence of a named instruction sheet in this VWWorkflowSignature's list of instruction sheet names.
Parameters:
theInstructionSheetName - A string holding the name of the instruction sheet to look for.
Returns:
true if theInstructionSheetName is found in the list of instruction sheet names in this VWWorkflowSignature; otherwise, returns false.

findField

public VWFieldDefinition findField(java.lang.String theFieldName)
Finds a field definition in the list of field definitions in this VWWorkflowSignature.
Parameters:
theFieldName - TheFieldName: the name of the field to return.
Returns:
The VWFieldDefinition object whose name matches the theFieldName parameter for the field, or null if the field definition 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

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

convertInstructionSheetNameToId

public int convertInstructionSheetNameToId(java.lang.String strISheetName)
                                    throws VWException
Converts an instruction sheet name to an instruction sheet ID. If the system does not find the name, another RPC occurs to retrieve an updated VWWorkflowSignature object that may have the ID.
Parameters:
strISheetName - The name of the instruction sheet to retrieve.
Returns:
The workflow ID for an instruction sheet
Throws:
VWException - An instruction sheet ID cannot be retrieved for the given instruction sheet name.
Since:
eP6.0


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