Process Class Relationships

Serialized Form


Package filenet.vw.api

Class filenet.vw.api.VWAttachment implements Serializable

Serialized Fields

attachmentName

java.lang.String attachmentName
Name associated with this attachment

attachmentDescription

java.lang.String attachmentDescription
Description associated with this attachment

id

java.lang.String id
Document ID associated with this attachment

version

java.lang.String version
The version of this attachment. This value does not need to be set.

library

java.lang.String library
Library or object store name associated with this attachment

attachmentType

int attachmentType
The type of this attachment.
See Also:
VWAttachmentType

libraryType

int libraryType
The type of the library of this attachment.
See Also:
VWLibraryType

Class filenet.vw.api.VWAttributeInfo implements Serializable

Serialized Fields

attributes

java.util.Hashtable attributes
Hash fields.

Class filenet.vw.api.VWCompoundStepDefinition implements Serializable

Serialized Fields

instructions

VWInstructionDefinition[] instructions
The array of instructions contained in this compound step. This array is maintained with contiguous elements, i.e. no gaps, deletion of an instruction compacts the array (but doesnt resize it). This array will be reallocated if it is already full when a new step needs to be added.
See Also:
VWInstructionDefinition

instructionsHandler

filenet.vw.api.VWArrayHandler instructionsHandler
A helper to manage the instruction definitions for this compound step. This will be initialized in the constructor because it needs to manage an array of the base class type VWInstructionDefinition. (see similar code in the mapdefinition)

Class filenet.vw.api.VWCreateLiveWOResult implements Serializable

Serialized Fields

workObjectNumber

java.lang.String workObjectNumber
The work object number returned by VWSession.createLiveWorkObject(). Null is valid if an error occurred while creating a work object, but this will throw an exception.

rosterName

java.lang.String rosterName
The roster name returned by the VWSession.createLiveWorkObject() method. Will be null if an error ocurred while createing a work object. An exception will be thrown in that case.

error

java.lang.String error
The error string returned by the VWSession.createLiveWorkObject() method, which may be null if there are no errors.

Class filenet.vw.api.VWEventDefinition implements Serializable

Serialized Fields

assignments

java.lang.String[][] assignments
Array of assignments. The assignments are a set of left value and right value pairs.

workClassName

java.lang.String workClassName
The name of the work class which will trigger this event. Value cannot be null.

callIS

java.lang.String callIS
The name of the map/instruction sheet which will be called when this event occurs. Value may be null.

op

java.lang.String op
the operator used to compare the tag value of the triggering workclass with the value in this event to decide if the event has occurred. Value must be one of the following: "=", ">", "<", "<>", "<=", ">=".

val

java.lang.String val
the value used to compare against the tag value of the triggering work class to decide if the event has occurred. Value cannot be null.

Class filenet.vw.api.VWException implements Serializable

Serialized Fields

key

java.lang.String key
Key for looking up a resource string in the VWExceptions file
See Also:
String

args

java.lang.Object[] args
Arguments to use when generating the final string

Class filenet.vw.api.VWExposedFieldDefinition implements Serializable

Serialized Fields

type

int type

length

int length

name

java.lang.String name

systemField

boolean systemField

bHasChanged

boolean bHasChanged

mandatorySystemField

boolean mandatorySystemField

sourceName

java.lang.String sourceName

sourceType

int sourceType

Class filenet.vw.api.VWFieldDefinition implements Serializable

Serialized Fields

description

java.lang.String description
A description of the data field.

fieldType

int fieldType
The data field's data type.
See Also:
VWFieldType

isArray

boolean isArray
Is the field an array ?

mergeType

int mergeType
The data field's merge type.
See Also:
VWMergeType

name

java.lang.String name
The data field name. it is unique within a workflow definition. Name syntax is restricted to 31 characters, begining with an alpha, and containing only alpha-numeric and underscore characters.

valueString

java.lang.String valueString
A String representation of the value.

canAssign

boolean canAssign
boolean flag, used in VWFieldDefinitions returned from the server in a VWWorkflowSignature at runtime, this flag is an indication that the field can be an LValue in an assignment, For design-time, it's value is always true and it is not persisted to the XML (.pep) file.

myWorkflow

VWWorkflowDefinition myWorkflow
A reference to the containing workflow definition object.

Class filenet.vw.api.VWIndexDefinition implements Serializable

Serialized Fields

name

java.lang.String name

fieldNames

java.lang.String[] fieldNames

systemIndex

boolean systemIndex

mandatorySystemIndex

boolean mandatorySystemIndex

bHasChanged

boolean bHasChanged

tableDefinition

filenet.vw.api.VWTableDefinition tableDefinition

Class filenet.vw.api.VWInjectSessionInfo implements Serializable

Class filenet.vw.api.VWInstructionDefinition implements Serializable

Serialized Fields

instructionId

int instructionId
The instruction id of this instruction. Instruction ids are unique within a workflow map, and are generated in the VWMapDefiniton object. NOTE: These instruction ids come from the same pool of ids as the VWStepDefinition stepIds, because on the server they all become work order ids. (the pool is generated from the stepIdGenerator in the VWMapDefinition) In order to enforce the uniqueness constraints above,The instruction id can normally only be set by the constructor, but an exception to this rule is that when reading an instruction from XML, the instruction id stored in the XML file is used. Another exception is that when pasting compound steps into a map, all the instruction ids will be regenerated using the step id generator of the map being pasted into.
See Also:
VWMapDefinition

action

int action
The action id for this instruction, for example, it's a call instruction, or an assign instruction.
See Also:
VWActionType

Class filenet.vw.api.VWInstructionElement implements Serializable

Class filenet.vw.api.VWLogDefinition implements Serializable

Class filenet.vw.api.VWLogElement implements Serializable

Serialized Fields

FTimeStamp

java.lang.String FTimeStamp

FSeqNumber

java.lang.String FSeqNumber

FEventType

java.lang.String FEventType

FWorkOrderId

java.lang.String FWorkOrderId

FMachineId

java.lang.String FMachineId

FDuration

java.lang.String FDuration

FText

java.lang.String FText

FParentWobNum

java.lang.String FParentWobNum

FOperationName

java.lang.String FOperationName

Class filenet.vw.api.VWMapDefinition implements Serializable

Serialized Fields

name

java.lang.String name
The name of this workflow map, must be unique within the containing workflow definition.

mapId

int mapId
The map id, this will only be valid if it comes from XML retrieved from the server, -1 is an invalid value. Authored workflows will have invalid map ids.

description

java.lang.String description
A description of this workflow map.

myWorkflow

VWWorkflowDefinition myWorkflow
A reference to the containing workflow definition object.

steps

VWMapNode[] steps
The array of steps contained in this workflow map. This array is maintained with contiguous elements, i.e. no gaps, deletion of a step compacts the array (but doesnt resize it). This array will be reallocated if it is already full when a new step needs to be added.
See Also:
VWStepDefinition

stepsHandler

filenet.vw.api.VWArrayHandler stepsHandler
A helper to manage the step definitions for this workflow map.

stepIdGenerator

filenet.vw.api.VWIdGenerator stepIdGenerator
stepIdGenerator is used to maintain unique step IDs within this workflow map. Each step in a workflow map must have a unique step ID. Step IDs do not have to be unique across workflow maps. Step Ids become authored work order ids on the server. Note that both the step ids stored in VWMapNodes and the ids allocated to the instruction in a compound step come from this same pool of ids. When loading an existing workflow map, the stepIdCounter should be set to one more than the highest step ID found in the existing workflow map. The counter can be set to one more than the current highest step ID using the private UpdateNextStepId () method.
See Also:
VWIdGenerator

routes

VWRouteDefinition[] routes
An array of all the routes for this map.
See Also:
VWRouteDefinition

routesHandler

filenet.vw.api.VWArrayHandler routesHandler
A helper to manage the routes for this map.

routeIdGenerator

filenet.vw.api.VWIdGenerator routeIdGenerator
routeIdGenerator is used to maintain unique route IDs within this workflow map. Each route in a workflow map must have a unique route ID. Route IDs do not have to be unique across workflow maps.
See Also:
VWIdGenerator

pasteMapName

java.lang.String pasteMapName
Name used for temporary map created during pasting of step definitions into another map;

seen

int[] seen

visitOrd

int visitOrd

Class filenet.vw.api.VWMapNode implements Serializable

Serialized Fields

name

java.lang.String name
The name of this node.

stepId

int stepId
The step id of this step. Step ids are unique within a workflow map, and are generated in the VWMapDefiniton object which contains the step.
See Also:
VWMapDefinition, VWRouteDefinition

description

java.lang.String description
A description of this node.

location

java.awt.Point location
A co-ordinate pair (a point) associated with this step, for use in displaying the step in a GUI.
See Also:
Point

splitType

int splitType
The split type of this step, SPLIT_TYPE_NONE is used for non-split steps.
See Also:
VWSplitType

joinType

int joinType
The join type of this step, JOIN_TYPE_NONE is used for non-join steps.
See Also:
VWJoinType

joinStepId

int joinStepId
The join step id of this step. If this step is an AND split step, the join step id is the step id of the corresponding AND join step, otherwise it will be set to INVALID_STEP_ID (-1). Typically, the user will not set this value, this value will be filled in during validation, and may become invalid if the geometry of the map changes after validation (e.g. steps added or deleted, join/split types change, etc). Validation should be called before doing a transfer. The join step id is needed on the server side for figuring out how to do splits and rendevous.
See Also:
VWMapDefinition, VWRouteDefinition

myMap

VWMapDefinition myMap
A reference to the containing Map definition object.

outGoingRoutes

java.lang.Integer[] outGoingRoutes
An array of out-going route ids for this step. The order in which the route ids occur in the array is the order in which the route conditions will be evaluated at runtime.
See Also:
VWParameterDefinition, VWMapNode.reorderRoutes(int[])

outGoingRoutesHandler

filenet.vw.api.VWArrayHandler outGoingRoutesHandler
A helper to manage the outgoing routes for this step.

Class filenet.vw.api.VWMilestoneDefinition implements Serializable

Serialized Fields

name

java.lang.String name
Name associated with this milestone

message

java.lang.String message
Message associated with this milestone

level

int level
Level associated with this milestone 1 - regular users, 2 - managers (includes level 1), 3 - Workflow administrators (includes level 1 and 2)

myWorkflow

VWWorkflowDefinition myWorkflow
A reference to the containing workflow definition object.

Class filenet.vw.api.VWNewWorkObject implements Serializable

Serialized Fields

roster

VWRoster roster

savePerformed

boolean savePerformed

Class filenet.vw.api.VWOperationDefinition implements Serializable

Serialized Fields

name

java.lang.String name
The name of this operation, unique within the queue that this operation is defined in.

description

java.lang.String description
The description of this operation, may be null.

myQueue

VWQueueDefinition myQueue
A reference to the containing queue, used for validation, e.g. to check that the name is unique when setting name

parameters

VWParameterDefinition[] parameters
The parameters in this operation

parametersHandler

filenet.vw.api.VWArrayHandler parametersHandler
A helper to manage the parameters definitions for this operation.

attributes

java.util.Hashtable attributes
Hashtable of attributes. The assignments are a set of left value and right value pairs.

Class filenet.vw.api.VWParameterDefinition implements Serializable

Serialized Fields

name

java.lang.String name
The name of the parameter, matches the data field definition name for the corresponding data field.

value

java.lang.String value
The value expression of the parameter. For the Rhine release, the value of the parameter is the same as the name of the parameter and it matches the name of the data field definition for the corresponding data field.

description

java.lang.String description
A description of the parameter.

mode

int mode
The mode ("direction") of the parameter.
See Also:
VWModeType

isArray

boolean isArray
A flag which indicates whether the parameter is an array.

dataType

int dataType
The parameter's data type. The value of the data type must be one of the values defined in VWFieldType.
See Also:
VWFieldType

myContainer

filenet.vw.api.IVWHasParameterDefs myContainer
A reference to the containing step object, maybe a step definition or an operation definition.

Class filenet.vw.api.VWParticipant implements Serializable

Serialized Fields

participantName

java.lang.String participantName
The name of the participant, a user or a user group.

Class filenet.vw.api.VWProcess implements Serializable

Serialized Fields

processId

java.lang.String processId
The id for this process; corresponds to a workobject number.

bufferSize

int bufferSize
The maximum number of data objects to return at a time. The actual number returned from the server may be less. It all depends on memory. This is only an internal buffer and has no bearing on the TOTAL number of objects that are actually returned to the user. It is used for efficiency. For example, if there are 150 objects and bufferSize is 1, then there will be 150 RPCs to get each object. Setting bufferSize to 50 will make 3 RPCs.

theRoster

VWRoster theRoster

rosterName

java.lang.String rosterName
The roster to which this process is associated.

serviceSession

VWSession serviceSession
The VWSession returned from the logon

rosterQuery

VWRosterQuery rosterQuery
The roster query used for this process.

workObjectNumber

java.lang.String workObjectNumber
The work object associated with this process.

eventLogName

java.lang.String eventLogName
The event log name associated with this process.

workClassName

java.lang.String workClassName
The work class name associated with this process.

mileStoneDefinitions

VWMilestoneDefinition[] mileStoneDefinitions
The milestone data associated with this process.

workSpaceId

int workSpaceId
The workspace ID associated with this process.

workClassId

int workClassId
The workspace ID associated with this process.

bInitialized

boolean bInitialized
Flag to indicate if the query is initialized

bInitializing

boolean bInitializing
Flag to indicate it is currently initializing the query. It is used to avoid recusive loops.

Class filenet.vw.api.VWQueueDefinition implements Serializable

Serialized Fields

queueType

int queueType

logicalName

java.lang.String logicalName

operations

VWOperationDefinition[] operations

operationsHandler

filenet.vw.api.VWArrayHandler operationsHandler

Class filenet.vw.api.VWQueueElement implements Serializable

Class filenet.vw.api.VWQueueStats implements Serializable

Serialized Fields

InitialQueueCount

java.lang.String InitialQueueCount

RemainingQueuedCount

java.lang.String RemainingQueuedCount

WOLockedCount

java.lang.String WOLockedCount

AvgWOProcessingTime

java.lang.String AvgWOProcessingTime

AvgThroughput

java.lang.String AvgThroughput

AvgQueueDelay

java.lang.String AvgQueueDelay

WODequeuedCount

java.lang.String WODequeuedCount

WOQueuedCount

java.lang.String WOQueuedCount

AbortedCount

java.lang.String AbortedCount

ServiceTime

java.lang.String ServiceTime

AbortedTime

java.lang.String AbortedTime

WOProcessedCount

java.lang.String WOProcessedCount

QueuedRate

java.lang.String QueuedRate

DequeuedRate

java.lang.String DequeuedRate

SumDurationWOInQueue

java.lang.String SumDurationWOInQueue

QueueGrowthRate

java.lang.String QueueGrowthRate

AvgQueueDepth

java.lang.String AvgQueueDepth

AvgProcessedWOs

java.lang.String AvgProcessedWOs

AvgWOLocked

java.lang.String AvgWOLocked

SumQueueDepth

java.lang.String SumQueueDepth

SumNumberWOProcessed

java.lang.String SumNumberWOProcessed

SumWOLocked

java.lang.String SumWOLocked

CurrentQueueDepth

java.lang.String CurrentQueueDepth

CurrentWOLocked

java.lang.String CurrentWOLocked

Class filenet.vw.api.VWRollbackInstruction implements Serializable

Serialized Fields

params

java.lang.String[] params
An array of parameters for this rollback instuction. This is a list of no-rolled-back-fields, it is called params because this simplifies the JNI coding on the server side.

compCallIS

java.lang.String compCallIS
The name of an instruction sheet which will be run to compensate for the effect of this rollback instuction.

reDoExpr

java.lang.String reDoExpr
A boolean expression which controls which instruction is executed immediately after the rollback instruction.

Class filenet.vw.api.VWRosterDefinition implements Serializable

Serialized Fields

createSecurity

java.lang.String[] createSecurity

Class filenet.vw.api.VWRosterElement implements Serializable

Class filenet.vw.api.VWRosterStats implements Serializable

Serialized Fields

InitialWOsCount

java.lang.String InitialWOsCount

InitialParentsCount

java.lang.String InitialParentsCount

InitialChildrenCount

java.lang.String InitialChildrenCount

RemainingTotalWOsCount

java.lang.String RemainingTotalWOsCount

RemainingParentsCount

java.lang.String RemainingParentsCount

RemainingChildrenCount

java.lang.String RemainingChildrenCount

CreatedTotalWOsCount

java.lang.String CreatedTotalWOsCount

CreatedParentsCount

java.lang.String CreatedParentsCount

CreatedChildrenCount

java.lang.String CreatedChildrenCount

TerminatedTotalWOsCount

java.lang.String TerminatedTotalWOsCount

TerminatedParentsCount

java.lang.String TerminatedParentsCount

TerminatedChildrenCount

java.lang.String TerminatedChildrenCount

CreationTotalRate

java.lang.String CreationTotalRate

CreationParentRate

java.lang.String CreationParentRate

CreationChildrenRate

java.lang.String CreationChildrenRate

TerminationTotalRate

java.lang.String TerminationTotalRate

TerminationParentRate

java.lang.String TerminationParentRate

TerminationChildrenRate

java.lang.String TerminationChildrenRate

GrowTotalRate

java.lang.String GrowTotalRate

GrowParentRate

java.lang.String GrowParentRate

GrowChildrenRate

java.lang.String GrowChildrenRate

SumWOLifeSpan

java.lang.String SumWOLifeSpan

SumParentLifeSpan

java.lang.String SumParentLifeSpan

SumChildrenLifeSpan

java.lang.String SumChildrenLifeSpan

AvgNumActiveWOs

java.lang.String AvgNumActiveWOs

AvgNumActiveParents

java.lang.String AvgNumActiveParents

AvgNumActiveChildren

java.lang.String AvgNumActiveChildren

AvgLifeSpanWOs

java.lang.String AvgLifeSpanWOs

AvgLifeSpanParents

java.lang.String AvgLifeSpanParents

AvgLifeSpanChildren

java.lang.String AvgLifeSpanChildren

SumActiveWOs

java.lang.String SumActiveWOs

SumActiveParents

java.lang.String SumActiveParents

SumActiveChildren

java.lang.String SumActiveChildren

CurrentWOsCount

java.lang.String CurrentWOsCount

CurrentParentsCount

java.lang.String CurrentParentsCount

CurrentChildrenCount

java.lang.String CurrentChildrenCount

Class filenet.vw.api.VWRouteDefinition implements Serializable

Serialized Fields

routeId

int routeId
The Route ID. A valid VWRouteDefinition must have a unique, within the map, routeId.

condition

java.lang.String condition
The condition associated with this route. The condition may be null.

sourceStepId

int sourceStepId
The Step ID of the route's source step. A valid VWRouteDefinition must have valid sourceStepId.
See Also:
VWMapNode

destinationStepId

int destinationStepId
The Step ID of the route's destination step. A valid VWRouteDefinition must have valid destinationStepId.
See Also:
VWMapNode

name

java.lang.String name
The route's name. The name does not need to be unique, and it may contain spaces and punctuation. It's main purpose is to provide a label for the UI representation of the route. The name may be null.

release

boolean release
Release is a boolean flag which indicates that a WorkObject following this route at runtime will not rendezvous. It is used when WOs from AND splits follow paths which never reach an AND join. The server knows not to wait for these WOs if the release flag for the route followed is set to true. The release flag will normally be automatically set to true during the join step id fixup, if a route is detected which will not rendezvouz This would normally be done before transfer.

myNode

VWMapNode myNode
A reference to the enclosing VWMapNode object. this reference to the containing node is needed to support implementation of getSourceStep() and getDestinationStep(), and used to check existence of source and destination step Ids.

Class filenet.vw.api.VWServerException implements Serializable

Serialized Fields

hexTuple

java.lang.Long hexTuple
Hex representation of VWServer Error
See Also:
String

Class filenet.vw.api.VWSession implements Serializable

Serialized Fields

cmdSession

filenet.vw.api.VWCommandSession cmdSession

serviceName

java.lang.String serviceName

routerURL

java.lang.String routerURL

isolatedRegion

int isolatedRegion

userNames

java.util.Hashtable userNames

configmap

filenet.vw.api.VWConfigResult configmap

auditFile

java.lang.String auditFile

auditOn

boolean auditOn

userName

java.lang.String userName

pw

java.lang.String pw

secList

VWSecurityList secList

BUFFERSIZE

int BUFFERSIZE

userInfo

VWUserInfo userInfo

lpar

java.lang.String lpar

rpar

java.lang.String rpar

numServers

int numServers

webAppId

int webAppId

queueNameCache

java.lang.String[] queueNameCache

rosterNameCache

java.lang.String[] rosterNameCache

USTR_NONE

java.lang.String USTR_NONE

USTR_ANYONE

java.lang.String USTR_ANYONE

USTR_SERVICE

java.lang.String USTR_SERVICE

USTR_INTERNAL_USER

java.lang.String USTR_INTERNAL_USER

NCHServerName

java.lang.String NCHServerName

NCHServerDomain

java.lang.String NCHServerDomain

NCHServerOrganization

java.lang.String NCHServerOrganization

DELIM

java.lang.String DELIM

Class filenet.vw.api.VWSimpleInstruction implements Serializable

Serialized Fields

params

java.lang.String[] params
The array of parameters for the action contained in this instuction.

Class filenet.vw.api.VWStepDefinition implements Serializable

Serialized Fields

canReassign

boolean canReassign
Flag to indicate whether reassignment is allowed at this step by the step processor.

canViewStatus

boolean canViewStatus
Flag to indicate whether status can be viewed at this step by the step processor.

queueName

java.lang.String queueName
The name of the queue associated with this step, can be null if this step does not have an associated queue.

operationName

java.lang.String operationName
The name of the operation associated with this step, should be null if this step does not have an associated queue, may be null even if there is a queue, but the step doesn't execute an operation on that queue.

operationParameters

java.lang.String[] operationParameters
An array of strings which are the expressions representing the parameters for an operation. This should only have a non-null value if this set has a non null operation name, In which case the step cannot have any parameter definitions.

requestedInterface

java.lang.String requestedInterface
A string, usually a step processor name used to handle the UI for this step.

participants

VWParticipant[] participants
The list of participant for this step.

responses

java.lang.String[] responses
The list of response strings for this step.

parameters

VWParameterDefinition[] parameters
An array of parameter definitions for this step.
See Also:
VWParameterDefinition

parametersHandler

filenet.vw.api.VWArrayHandler parametersHandler
A helper to manage the parameters definitions for this step.

deadline

long deadline
The deadline (in minutes) for this step. Deadline represents the number of minutes between the time work starts on a step and expiration of the deadline timer. A value of 0 indicates the absence of a deadline.

reminder

long reminder
The reminder (in minutes) for this step. Reminder represents the number of minutes prior to the expiration of the deadline timer that the reminder timer will expire. A value of 0 indicates the absence of a reminder. The value for reminder should be less than the value for deadline.

preAssignments

java.lang.String[][] preAssignments
Array of pre assignments. The assignments are a set of left value and right value pairs.

postAssignments

java.lang.String[][] postAssignments
Array of post assignments. The assignments are a set of left value and right value pairs.

attributes

java.util.Hashtable attributes
Array of attributes. The assignments are a set of left value and right value pairs.

postMilestone

java.lang.String postMilestone
Post milestone. The name of a milestone in the workflow.

preMilestone

java.lang.String preMilestone
Pre milestone. The name of a milestone in the workflow.

Class filenet.vw.api.VWStepElement implements Serializable

Serialized Fields

comment

java.lang.String comment
Comment the participant enters for this step element

dateReceived

java.util.Date dateReceived
Date on which the participant received this step

launchDate

java.util.Date launchDate
Date on which the workflow process associated with this step started

selectedResponse

int selectedResponse
Index to participant response for this step

myStepDef

VWStepDefinition myStepDef
Reference to the containing Step definition object

processId

java.lang.String processId
Process ID number (corresponds to the work object number)

availableResponses

java.lang.Object[] availableResponses
List of available responses

IWStepDescription

java.lang.String IWStepDescription

IWStepResponses

java.lang.String IWStepResponses

NewWorkflowNumber

java.lang.String NewWorkflowNumber

NewWorkSpaceId

int NewWorkSpaceId

cmdSession

filenet.vw.api.VWCommandSession cmdSession

Class filenet.vw.api.VWStepProcessorInfo implements Serializable

Class filenet.vw.api.VWStepProcessorInfoDefinition implements Serializable

Class filenet.vw.api.VWTransferResult implements Serializable

Serialized Fields

errors

java.lang.String[] errors
The array of error strings returned by transfer, may be null if no errors, in which case version should be non-null.

version

java.lang.String version
The version returned by transfer. Will be null if errors ocurred during transfer, in which case errors will be non-null. This should be the toString() for of a VWVersionInfo object.

Class filenet.vw.api.VWWFEInstruction implements Serializable

Serialized Fields

events

VWEventDefinition[] events
The array of the events that this wait for event instruction waits for. This array is maintained with contiguous elements, i.e. no gaps, deletion of an event compacts the array (but doesnt resize it). This array will be reallocated if it is already full when a new step needs to be added.
See Also:
VWEventDefinition

eventsHandler

filenet.vw.api.VWArrayHandler eventsHandler
A helper to manage the instruction definitions for this compound step. This will be initialized in the constructor because it needs to manage an array of the base class type VWInstructionDefinition. (see similar code in the mapdefinition)

timeOut

java.lang.String timeOut
A time expression representing the maximum number of minutes to wait for an event to occur. A value of 0 means wait for ever.

eventNumLoc

java.lang.String eventNumLoc
A numeric Lvalue expression which is the location where the row number of the event causing the wait for event to wake up will be stored.

Class filenet.vw.api.VWWorkflowDefinition implements Serializable

Serialized Fields

description

java.lang.String description
The description of the workflow can be anything the user wants to put as a description of the workflow definition.

subject

java.lang.String subject
The Workflow's subject, the subject is intended to be used as a "mini description" of the workflow definition.

name

java.lang.String name
The name of this WorkflowDefinition. May be null. The name will be used to make part of the WorkClass name when the workflow definition is transfered.

maps

VWMapDefinition[] maps
An array of workflow map definitions for this workflow definition.
See Also:
VWMapDefinition

mapsHandler

filenet.vw.api.VWArrayHandler mapsHandler
A helper to manage the workflow map definitions for this workflow definition.

mainAttachmentName

java.lang.String mainAttachmentName
The name of the main attachment in this workflow definition. Can be null, meaining there is no "main" attachment. Attachments are stored as field definitions in this workflow definition, and the name can be used to find the field definition for the main attachment.
See Also:
VWFieldDefinition

baseWorkClassName

java.lang.String baseWorkClassName
The name of the WorkClass that this workflow definition will inherit from once it has been transferred to the server. Workflow definitions will normally inherit from "WorkObjectEx", which is defined in vwbase.cdl. Can be null, (normally will be null), in which case the inheritance will be set up from "WorkObjectEx" at transfer time.

rosterName

java.lang.String rosterName
The name of the roster that this workflow definition will use once it has been transferred to the server. Workflow definitions will normally inherit "DefaultRoster" from "WorkObjectEx", which is defined in vwbase.cdl. Can be null, (normally will be null), in which case the roster name will be set as whatever is inherited from "WorkObjectEx" at transfer time. if not null, will override inherited value at transfer time.

eventLogName

java.lang.String eventLogName
The name of the event log that this workflow definition will use once it has been transferred to the server. Workflow definitions will normally inherit "DefaultEventLog" from "WorkObjectEx", which is defined in vwbase.cdl. Can be null, (normally will be null), in which case the event log name will be set as whatever is inherited from "WorkObjectEx" at transfer time. if not null, will override inherited value at transfer time.

tag

java.lang.String tag
The tag is an expression of any type, which is evaluated at run time and stored in F_Tag. It is used during "wait for event" processing at run time.

fields

VWFieldDefinition[] fields
An array of data field definitions for this workflow definition.
See Also:
VWFieldDefinition

fieldsHandler

filenet.vw.api.VWArrayHandler fieldsHandler
A helper to manage the data field definitions for this workflow definition.

deadline

long deadline
The deadline (in minutes) for this workflow definition. Deadline represents the number of minutes between the time work starts on a step and expiration of the deadline timer. A value of 0 indicates the absence of a deadline.

reminder

long reminder
The reminder (in minutes) for this workflow definition. Reminder represents the number of minutes prior to the expiration of the deadline timer that the reminder timer will expire. A value of 0 indicates the absence of a reminder. The value for reminder should be less than the value for deadline.

milestones

VWMilestoneDefinition[] milestones
An array of milestone definitions for this workflow.
See Also:
VWMilestoneDefinition

milestonesHandler

filenet.vw.api.VWArrayHandler milestonesHandler
A helper to manage the milestone definitions for this workflow definition.

baseWorkclassSignature

VWWorkflowSignature baseWorkclassSignature
This member, baseWorkclassSignature will be initialized during validation, and used to look up fields and maps from the base workclass at that time.

stepProcessorDefinitions

VWStepProcessorInfo[] stepProcessorDefinitions
This member, baseWorkclassSignature will be initialized during validation, and used to look up step processor information at that time (during step Validation).

attributes

java.util.Hashtable attributes
Array of attributes. The assignments are a set of left value and right value pairs.

Class filenet.vw.api.VWWorkflowSignature implements Serializable

Serialized Fields

transferUserName

java.lang.String transferUserName

transferUserId

int transferUserId

transferDateTime

java.util.Date transferDateTime

F_TagExpression

java.lang.String F_TagExpression

F_TagType

int F_TagType

fieldDefinitions

VWFieldDefinition[] fieldDefinitions

iSheetNames

java.lang.String[] iSheetNames

Class filenet.vw.api.VWWorkObject implements Serializable

Serialized Fields

workFlowId

java.lang.String workFlowId
Workflow process ID number (corresponds to the work object number)

IWStepResponses

java.lang.String IWStepResponses

selectedResponse

int selectedResponse
Index to participant response for this step

availableResponses

java.lang.Object[] availableResponses
List of available responses


Process Class Relationships

Copyright © 2002 FileNET Corporation. All rights reserved.