|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWWorkflowSignature
public final class VWWorkflowSignature
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)
.
VWSession.fetchWorkflowSignature(java.lang.String)
,
VWSession.transfer(filenet.vw.api.VWWorkflowDefinition, java.lang.String, boolean, boolean)
,
Serialized FormMethod 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. |
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. |
void |
setFields(VWFieldDefinition[] theFields)
Set the fields in the signature. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
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 java.lang.String getTransferUserName()
VWWorkflowDefinition
,
VWSession.transfer(filenet.vw.api.VWWorkflowDefinition, java.lang.String, boolean, boolean)
public VWParticipant getTransferUserNamePx() throws VWException
VWException
public java.lang.String getRosterName()
Note: The translation is done only at runtime, so will not apply to design-time applications (such as the Process Designer or Configuration Console).
public java.lang.String getName()
Note: The translation is done only at runtime, so will not apply to design-time applications (such as the Process Designer or Configuration Console).
public boolean getHasMyPortType()
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.
true
if at least one of the partner links in
this workflow has a MyPortType property.VWReceiveInstruction
public boolean getVersionAgnostic()
true
indicates that
Process Engine message correlation does not use the version of the
workflow of the received instruction.
true
indicates that
Process Engine message correlation does not use the version of the
workflow of the received instruction.VWWorkflowDefinition.setVersionAgnostic( boolean )
,
Business Process Execution Language for Web Services Version 1.1,
Message Propertiespublic int getWorkspaceId()
public java.lang.String getEventLogName()
Note: The translation is done only at runtime, so will not apply to design-time applications (such as the Process Designer or Configuration Console).
VWWorkflowDefinition.setEventLogName
public java.lang.String getDescription()
Note: The translation is done only at runtime, so will not apply to design-time applications (such as the Process Designer or Configuration Console).
public int getTransferUserId()
public java.util.Date getTransferDateTime()
public java.lang.String getFTagExpression()
VWWFEInstruction.createEvent()
public int getFTagType()
VWWFEInstruction.createEvent()
public VWFieldDefinition[] getFieldDefinitions()
public java.lang.String[] getInstructionSheetNames()
Note: The translation is done only at runtime, so will not apply to design-time applications (such as the Process Designer or Configuration Console).
public boolean isInstructionSheetName(java.lang.String theInstructionSheetName)
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).
public VWFieldDefinition findField(java.lang.String theFieldName)
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).
public filenet.vw.base.exprcomp.IField getField(java.lang.String theName) throws java.lang.Exception
getField
in interface filenet.vw.base.exprcomp.IFieldCollection
java.lang.Exception
public java.util.Enumeration getFields() throws java.lang.Exception
getFields
in interface filenet.vw.base.exprcomp.IFieldCollection
java.lang.Exception
public int convertInstructionSheetNameToId(java.lang.String strISheetName) throws VWException
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).
VWException
- Various causes, including when an
instruction sheet ID was not found.public java.lang.String[] getMilestoneNames()
Note: The translation is done only at runtime, so will not apply to design-time applications (such as the Process Designer or Configuration Console).
public boolean isMilestoneName(java.lang.String theMilestoneName)
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).
public java.lang.String[] getRulesetNames()
Note: The translation is done only at runtime, so will not apply to design-time applications (such as the Process Designer or Configuration Console).
public boolean isRulesetName(java.lang.String theRulesetName)
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).
public java.lang.String[] getPartnerlinkNames()
Note: The translation is done only at runtime, so will not apply to design-time applications (such as the Process Designer or Configuration Console).
public boolean isPartnerlinkName(java.lang.String thePartnerlinkName)
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).
public java.lang.String[] getSchemaNames()
Note: The translation is done only at runtime, so will not apply to design-time applications (such as the Process Designer or Configuration Console).
public boolean isSchemaName(java.lang.String theSchemaName)
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).
public java.lang.String getBaseWorkClassName()
Note: The translation is done only at runtime, so will not apply to design-time applications (such as the Process Designer or Configuration Console).
public void setFields(VWFieldDefinition[] theFields) throws VWException
theFields
-
VWException
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |