Process API

Serialized Form


Package filenet.vw.api

Class filenet.vw.api.VWApplicationSpaceDefinition extends filenet.vw.api.VWMLABase implements Serializable

serialVersionUID: 7461L

Serialized Fields

revision

int revision

m_name

java.lang.String m_name

m_description

java.lang.String m_description

m_writeSecurity

java.lang.String[] m_writeSecurity

m_writeSecurityPx

VWParticipant[] m_writeSecurityPx

m_roleDefs

VWRoleDefinition[] m_roleDefs

m_roleDefHandler

filenet.vw.api.VWArrayHandler m_roleDefHandler

m_deletedRoleDefs

VWRoleDefinition[] m_deletedRoleDefs

m_deletedRoleDefHandler

filenet.vw.api.VWArrayHandler m_deletedRoleDefHandler

m_attributes

java.util.Hashtable<K,V> m_attributes
Hashtable of attributes. The assignments are a set of left value and right value pairs.


m_bHasChanged

boolean m_bHasChanged

m_nObjId

int m_nObjId

isSelectedForExport

boolean isSelectedForExport

Class filenet.vw.api.VWAssociationDefinition extends java.lang.Object implements Serializable

serialVersionUID: 464L

Serialized Fields

targetId

int targetId
The id of the target object, the target object can be either a map node or a route, and the target type must be used to determine which, because ids for steps and routes come from different pools, so a step and a route could have the same id.


targetType

int targetType
Target type can be used in conjunction with the target id to find the object that this association points to. Valid values for target type are defined in the VWAssociationTargetType class.


name

java.lang.String name
name of the association, can be null. ignored when testing for equality of associations. See equals() method ovewrridden in this class.


myTextAnnotation

VWTextAnnotationDefinition myTextAnnotation
A reference to the enclosing VWTextAnnotationDefinition object. Set by constructor only.


originalConnectorGraphicsInfosNode

java.lang.Object originalConnectorGraphicsInfosNode
When an association is created from an XPDL file, a reference to the association's original ConnectorGraphicsInfos node in the XPDL DOM tree is saved here. Later if this association is output to an XPDL file, the ConnectorGraphicsInfo can be added to the file. This object is defined as Object instead of its actual type Node (which requires importing org.w3c.dom.*) so that logic related to DOM trees stays in VWXMLHandler.java.

Class filenet.vw.api.VWAttachment extends java.lang.Object implements Serializable

serialVersionUID: 7552L

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 extends java.lang.Object implements Serializable

serialVersionUID: 7448L

Serialized Fields

attributes

java.util.Hashtable<K,V> attributes
Hash fields.

Class filenet.vw.api.VWCompoundStepDefinition extends VWMapNode implements Serializable

serialVersionUID: 7510L

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 extends filenet.vw.api.VWMLABase implements Serializable

serialVersionUID: 470L

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.


errnum

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


m_desc

java.lang.String m_desc

Class filenet.vw.api.VWEventDefinition extends filenet.vw.api.VWMLABase implements Serializable

serialVersionUID: 7458L

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.


myWFEInstruction

VWWFEInstruction myWFEInstruction
Allow this event to find his way back up to the containing WFE instruction. This is for MLA support, but could be generally useful.

Class filenet.vw.api.VWException extends java.lang.Exception implements Serializable

serialVersionUID: 7479L

Serialized Fields

key

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


args

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


m_bWrappedException

boolean m_bWrappedException

m_causeDescription

java.lang.String m_causeDescription

m_causeClassName

java.lang.String m_causeClassName

Class filenet.vw.api.VWExposedFieldDefinition extends filenet.vw.api.VWMLABase implements Serializable

serialVersionUID: 7504L

Serialized Fields

type

int type

length

int length

name

java.lang.String name

prompt

java.lang.String prompt

systemField

boolean systemField

bHasChanged

boolean bHasChanged

mandatorySystemField

boolean mandatorySystemField

sourceName

java.lang.String sourceName

sourceType

int sourceType

Class filenet.vw.api.VWFaultDefinition extends filenet.vw.api.VWMLABase implements Serializable

serialVersionUID: 7448L

Serialized Fields

m_Name

java.lang.String m_Name

m_FaultMapName

java.lang.String m_FaultMapName

m_FaultMessage

java.lang.String m_FaultMessage

myInstruction

filenet.vw.api.IVWHasFault myInstruction

Class filenet.vw.api.VWFieldDefinition extends filenet.vw.api.VWMLABase implements Serializable

serialVersionUID: 7544L

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.


xmlSchemaName

java.lang.String xmlSchemaName
if the field type is XML it may have an associated schema name. This will be null for all other field types, and attempting to get or set it for non-XML fields will result in an exception.


xmlSchemaElement

java.lang.String xmlSchemaElement
if the field type is XML it may have an associated element name. This will be null for all other field types, and attempting to get or set it for non-XML fields will result in an exception.


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. Null if this field definition is not contained in a VWWorkflowDefinition.


myWorkflowSignature

VWWorkflowSignature myWorkflowSignature
A reference to the containing workflow signature object. Null if this field definition is not contained in a VWWorkflowSignature.

Class filenet.vw.api.VWIndexDefinition extends filenet.vw.api.VWMLABase implements Serializable

serialVersionUID: 7479L

Serialized Fields

name

java.lang.String name

fieldNames

java.lang.String[] fieldNames

systemIndex

boolean systemIndex

mandatorySystemIndex

boolean mandatorySystemIndex

bHasChanged

boolean bHasChanged

tableDefinition

VWTableDefinition tableDefinition

Class filenet.vw.api.VWInstructionDefinition extends filenet.vw.api.VWMLABase implements Serializable

serialVersionUID: 7457L

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

myCompoundStep

VWCompoundStepDefinition myCompoundStep
reference to container, needed for creating/validating parameters and MLA support

Class filenet.vw.api.VWInstructionElement extends filenet.vw.api.VWWorkElement implements Serializable

serialVersionUID: 7524L

Class filenet.vw.api.VWInvokeInstruction extends VWInstructionDefinition implements Serializable

serialVersionUID: 7491L

Serialized Fields

m_PartnerLinkName

java.lang.String m_PartnerLinkName

m_InputMsgExpr

java.lang.String m_InputMsgExpr

m_OutputMsgExpr

java.lang.String m_OutputMsgExpr

m_OperationName

java.lang.String m_OperationName

m_InputMsgName

java.lang.String m_InputMsgName

m_OutputMsgName

java.lang.String m_OutputMsgName

m_TimeoutExpr

java.lang.String m_TimeoutExpr

m_TimeoutMap

java.lang.String m_TimeoutMap

m_CatchAll

VWFaultDefinition m_CatchAll

m_InComingParameters

VWWebServiceParameterDefinition[] m_InComingParameters

m_InComingParametersHandler

filenet.vw.api.VWArrayHandler m_InComingParametersHandler

m_OutGoingParameters

VWWebServiceParameterDefinition[] m_OutGoingParameters

m_OutGoingParametersHandler

filenet.vw.api.VWArrayHandler m_OutGoingParametersHandler

m_InputCorrelationSetName

java.lang.String m_InputCorrelationSetName

m_InputCorrelationSetProperties

java.lang.String[][] m_InputCorrelationSetProperties

m_OutputCorrelationSetName

java.lang.String m_OutputCorrelationSetName

m_OutputCorrelationSetProperties

java.lang.String[][] m_OutputCorrelationSetProperties

m_Faults

VWFaultDefinition[] m_Faults
An array of faults for this invoke instruction. This array is maintained with contiguous elements, i.e. no gaps, deletion of a fault compacts the array (but doesn't resize it). This array will be reallocated if it is already full when a new fault needs to be added.

See Also:
VWFaultDefinition

m_FaultsHandler

filenet.vw.api.VWArrayHandler m_FaultsHandler
A helper to manage the fault definitions for this invoke instruction.


m_UseReliableMessaging

boolean m_UseReliableMessaging

Class filenet.vw.api.VWLog extends filenet.vw.api.VWPersistentCollection implements Serializable

Serialized Fields

logServers

filenet.vw.api.VWLogSub[] logServers

cmdSessions

filenet.vw.server.IPECommands[] cmdSessions

Class filenet.vw.api.VWLogDefinition extends VWTableDefinition implements Serializable

serialVersionUID: 7494L

Class filenet.vw.api.VWLogElement extends filenet.vw.api.VWWorkElement implements Serializable

serialVersionUID: 7497L

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 extends filenet.vw.api.VWMLABase implements Serializable

serialVersionUID: 7557L

Serialized Fields

m_className

java.lang.String m_className

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.


annotations

VWTextAnnotationDefinition[] annotations
An array of all the annotations for this map.

See Also:
VWTextAnnotationDefinition

annotationsHandler

filenet.vw.api.VWArrayHandler annotationsHandler
A helper to manage the annotatations 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

annotationIdGenerator

filenet.vw.api.VWIdGenerator annotationIdGenerator
annotationIdGenerator is used to maintain unique annotation IDs within this workflow map. Each annotation in a workflow map must have a unique annotation ID. Annotation 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

beenThere

java.util.Vector<E> beenThere

Class filenet.vw.api.VWMapNode extends filenet.vw.api.VWMLABase implements Serializable

serialVersionUID: 7463L

Serialized Fields

name

java.lang.String name
The name of the current 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 the current node.


documentation

java.lang.String documentation
A documentation of the current 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.


myStepPalette

VWStepPaletteDefinition myStepPalette
A reference to the containing step palette definition object.


attributes

VWAttributeInfo attributes
Array of attributes. The assignments are a set of left value and right value pairs.


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.


ruleSets

java.lang.String[][] ruleSets
Three arrays used to hold the rulesets for a node. The arrays represent, in order, the PRE_RULESETS, UPDATE_RULESETS and POST_RULESETS.


originalNodeGraphicsInfosNode

java.lang.Object originalNodeGraphicsInfosNode
When a map node is created from an XPDL file, a reference to the map node's original NodeGraphicsInfos node in the XPDL DOM tree is saved here. Later if this map node is output to an XPDL file, the NodeGraphicsInfo from other other (non-FileNet) applications can be added to the file. This object is defined as Object instead of its actual type Node (which requires importing org.w3c.dom.*) so that logic related to DOM trees stays in VWXMLHandler.java.

Class filenet.vw.api.VWMilestoneDefinition extends filenet.vw.api.VWMLABase implements Serializable

serialVersionUID: 7460L

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.VWOperationDefinition extends filenet.vw.api.VWMLABase implements Serializable

serialVersionUID: 7488L

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<K,V> attributes
Hashtable of attributes. The assignments are a set of left value and right value pairs.

Class filenet.vw.api.VWParameterDefinition extends filenet.vw.api.VWMLABase implements Serializable

serialVersionUID: 7536L

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 that 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 extends java.lang.Object implements Serializable

serialVersionUID: 7460L

Serialized Fields

m_participantName

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


m_distinguishedName

java.lang.String m_distinguishedName

m_displayName

java.lang.String m_displayName

m_guid

java.lang.String m_guid

m_userId

long m_userId

m_secDomainName

java.lang.String m_secDomainName

m_type

int m_type

m_bVerified

boolean m_bVerified

m_cmdSession

filenet.vw.server.IPECommands m_cmdSession

Class filenet.vw.api.VWParticipantList extends java.lang.Object implements Serializable

serialVersionUID: 471L

Serialized Fields

bufferSize

int bufferSize

fetchedObjects

VWParticipant[] fetchedObjects

idList

java.lang.Long[] idList

returnCount

int returnCount

fetchCount

int fetchCount

queryIsOver

boolean queryIsOver

lastRecord

java.lang.String lastRecord

listNameType

int listNameType

session

VWSession session

NCHServerName

java.lang.String NCHServerName

NCHServerDomain

java.lang.String NCHServerDomain

NCHServerOrganization

java.lang.String NCHServerOrganization

searchPattern

java.lang.String searchPattern

domain

java.lang.String domain

searchType

int searchType

sortType

int sortType

rpcArgFlag

long rpcArgFlag

inMemory

boolean inMemory
---------------------------------------------------------------- 2008/07/11: Quynh: We may want another flavor of VWParticipantList to get the role participants. For now, the plan is just to shuffle everything over, in memory. Eventually, if we have a way to do an iterator for the server that would be great.

Class filenet.vw.api.VWPartnerLinkDefinition extends filenet.vw.api.VWMLABase implements Serializable

serialVersionUID: 7456L

Serialized Fields

m_Name

java.lang.String m_Name

m_MyPortType

java.lang.String m_MyPortType

m_MyRole

java.lang.String m_MyRole

m_PartnerEndPoint

java.lang.String m_PartnerEndPoint

m_PartnerPortType

java.lang.String m_PartnerPortType

m_PartnerRole

java.lang.String m_PartnerRole

m_ReceiveInstns

java.util.Vector<E> m_ReceiveInstns

m_ReplyInstns

java.util.Vector<E> m_ReplyInstns

myWorkflow

VWWorkflowDefinition myWorkflow
A reference to the containing workflow definition object.

Class filenet.vw.api.VWProcess extends filenet.vw.api.VWMLABase implements Serializable

serialVersionUID: 7536L

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.


theWorkflowDef

VWWorkflowDefinition theWorkflowDef
we will cache the WorkflowDefinition fetched from the server, because the server toXML code can be expensive, and the workflow definition for a particular process won't change after it is first fetched.


theLastConvertFlag

boolean theLastConvertFlag
we need to record the convert flag passed to fetchWorkflowDefinition so that we can tell if the cached workflow definition matches the next callers request for a workflow definition.

Class filenet.vw.api.VWQueue extends filenet.vw.api.VWPersistentCollection implements Serializable

serialVersionUID: 119040L

Serialized Fields

FSortRule

java.lang.String FSortRule
System defined indexes for the queue


FFifo

java.lang.String FFifo

operationNames

java.lang.String[] operationNames

queueType

int queueType

userId

int userId

bufferSize

int bufferSize

isConnectorQueue

boolean isConnectorQueue

Class filenet.vw.api.VWQueueDefinition extends VWTableDefinition implements Serializable

serialVersionUID: 119049L

Serialized Fields

queueType

int queueType

isConnectorQueue

boolean isConnectorQueue

logicalName

java.lang.String logicalName
The logical table name for this queue.


operations

VWOperationDefinition[] operations
Array of operation defs.


operationsHandler

filenet.vw.api.VWArrayHandler operationsHandler

m_workBasketDefs

VWWorkBasketDefinition[] m_workBasketDefs
Array of work basket definitions.


m_workBasketDefHandler

filenet.vw.api.VWArrayHandler m_workBasketDefHandler

m_deletedWorkBasketDefs

VWWorkBasketDefinition[] m_deletedWorkBasketDefs

m_deletedWorkBasketDefHandler

filenet.vw.api.VWArrayHandler m_deletedWorkBasketDefHandler

Class filenet.vw.api.VWQueueElement extends filenet.vw.api.VWWorkElement implements Serializable

serialVersionUID: 7557L

Class filenet.vw.api.VWQueueQuery extends filenet.vw.api.VWQuery implements Serializable

serialVersionUID: 7424L

Class filenet.vw.api.VWQueueStats extends filenet.vw.api.VWStatistics implements Serializable

serialVersionUID: 7463L

Serialized Fields

InitialQueueCount

double InitialQueueCount

RemainingQueuedCount

double RemainingQueuedCount

WOLockedCount

double WOLockedCount

AvgWOProcessingTime

double AvgWOProcessingTime

AvgThroughput

double AvgThroughput

AvgQueueDelay

double AvgQueueDelay

WODequeuedCount

double WODequeuedCount

WOQueuedCount

double WOQueuedCount

AbortedCount

double AbortedCount

ServiceTime

double ServiceTime

AbortedTime

double AbortedTime

WOProcessedCount

double WOProcessedCount

QueuedRate

double QueuedRate

DequeuedRate

double DequeuedRate

SumDurationWOInQueue

double SumDurationWOInQueue

QueueGrowthRate

double QueueGrowthRate

AvgQueueDepth

double AvgQueueDepth

AvgProcessedWOs

double AvgProcessedWOs

AvgWOLocked

double AvgWOLocked

SumQueueDepth

double SumQueueDepth

SumNumberWOProcessed

double SumNumberWOProcessed

SumWOLocked

double SumWOLocked

CurrentQueueDepth

double CurrentQueueDepth

CurrentWOLocked

double CurrentWOLocked

Class filenet.vw.api.VWReceiveInstruction extends VWInstructionDefinition implements Serializable

serialVersionUID: 7510L

Serialized Fields

m_PartnerLinkName

java.lang.String m_PartnerLinkName

m_OperationName

java.lang.String m_OperationName

m_MessageExpr

java.lang.String m_MessageExpr

m_MessageFromSchemaName

java.lang.String m_MessageFromSchemaName

m_MessageFromElementName

java.lang.String m_MessageFromElementName

m_Parameters

VWWebServiceParameterDefinition[] m_Parameters

m_ParametersHandler

filenet.vw.api.VWArrayHandler m_ParametersHandler

m_TimeoutExpr

java.lang.String m_TimeoutExpr

m_TimeoutMap

java.lang.String m_TimeoutMap

m_Authentication

boolean m_Authentication

m_CorrelationSetName

java.lang.String m_CorrelationSetName

m_CorrelationSetProperties

java.lang.String[][] m_CorrelationSetProperties

m_OnlineID

int m_OnlineID

m_CorrelationParameterSeqNumber

int m_CorrelationParameterSeqNumber

m_CorrelationValueExpression

java.lang.String m_CorrelationValueExpression

m_SecurityGroup

java.lang.String[] m_SecurityGroup

Class filenet.vw.api.VWReplyInstruction extends VWInstructionDefinition implements Serializable

serialVersionUID: 7480L

Serialized Fields

m_PartnerLinkName

java.lang.String m_PartnerLinkName

m_OperationName

java.lang.String m_OperationName

m_FaultName

java.lang.String m_FaultName

m_MessageExpr

java.lang.String m_MessageExpr

m_MessageFromSchemaName

java.lang.String m_MessageFromSchemaName

m_MessageFromElementName

java.lang.String m_MessageFromElementName

m_Parameters

VWWebServiceParameterDefinition[] m_Parameters

m_ParametersHandler

filenet.vw.api.VWArrayHandler m_ParametersHandler

m_CorrelationSetName

java.lang.String m_CorrelationSetName

m_CorrelationSetProperties

java.lang.String[][] m_CorrelationSetProperties

m_HasAttachments

boolean m_HasAttachments

Class filenet.vw.api.VWReturnStackElement extends filenet.vw.api.VWMLABase implements Serializable

serialVersionUID: 470L

Serialized Fields

m_mapName

java.lang.String m_mapName
The map name.


m_mapId

int m_mapId
The map id.


m_stepName

java.lang.String m_stepName
The step name.


m_stepId

int m_stepId
The step id.


m_errorNumber

java.lang.String m_errorNumber
The error number - this is most likely the error tuple.


m_errorMessage

java.lang.String m_errorMessage
The error message text. The error tuple translated into a text message.


myCmdSession

filenet.vw.server.IPECommands myCmdSession

Class filenet.vw.api.VWRole extends java.lang.Object implements Serializable

serialVersionUID: 7424L

Serialized Fields

revision

int revision

name

java.lang.String name

description

java.lang.String description

homePageURL

java.lang.String homePageURL

attributes

VWAttributeInfo attributes

applicationSpaceName

java.lang.String applicationSpaceName

workBasketRefs

VWRole.WorkBasketReference[] workBasketRefs

cmdSession

filenet.vw.server.IPECommands cmdSession

objId

int objId

session

VWSession session

m_desc

java.lang.String m_desc

Class filenet.vw.api.VWRole.WorkBasketReference extends java.lang.Object implements Serializable

serialVersionUID: 7424L

Serialized Fields

qName

java.lang.String qName

wbAuthoredName

java.lang.String wbAuthoredName

role

VWRole role

desc

java.lang.String desc

Class filenet.vw.api.VWRoleDefinition extends filenet.vw.api.VWMLABase implements Serializable

serialVersionUID: 7460L

Serialized Fields

m_name

java.lang.String m_name

m_description

java.lang.String m_description

m_homePageURL

java.lang.String m_homePageURL

m_roleParticipants

VWParticipant[] m_roleParticipants

m_roleParticipantsNames

java.lang.String[] m_roleParticipantsNames

m_hasRoleParticipantsChanged

boolean m_hasRoleParticipantsChanged

m_bRoleParicipantFetched

boolean m_bRoleParicipantFetched

m_workBasketDefs

VWWorkBasketDefinition[] m_workBasketDefs

m_ORBWorkBaskets

filenet.vw.server.WorkBasketRef[] m_ORBWorkBaskets

m_nObjId

int m_nObjId

m_nRevision

int m_nRevision

m_attributes

java.util.Hashtable<K,V> m_attributes
Hashtable of attributes. The assignments are a set of left value and right value pairs.

Class filenet.vw.api.VWRollbackInstruction extends VWInstructionDefinition implements Serializable

serialVersionUID: 7447L

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 that controls which instruction is executed immediately after the rollback instruction.

Class filenet.vw.api.VWRoster extends filenet.vw.api.VWPersistentCollection implements Serializable

serialVersionUID: 7555L

Serialized Fields

FWobTag

java.lang.String FWobTag
System defined indexes only for a roster


fields

filenet.vw.server.VWField[] fields

bufferSize

int bufferSize

Class filenet.vw.api.VWRosterDefinition extends VWTableDefinition implements Serializable

serialVersionUID: 7509L

Serialized Fields

createSecurity

java.lang.String[] createSecurity

createSecurityPx

VWParticipant[] createSecurityPx

Class filenet.vw.api.VWRosterElement extends filenet.vw.api.VWWorkElement implements Serializable

serialVersionUID: 7537L

Class filenet.vw.api.VWRosterQuery extends filenet.vw.api.VWQuery implements Serializable

Class filenet.vw.api.VWRosterStats extends filenet.vw.api.VWStatistics implements Serializable

serialVersionUID: 7458L

Serialized Fields

InitialWOsCount

double InitialWOsCount

InitialParentsCount

double InitialParentsCount

InitialChildrenCount

double InitialChildrenCount

RemainingTotalWOsCount

double RemainingTotalWOsCount

RemainingParentsCount

double RemainingParentsCount

RemainingChildrenCount

double RemainingChildrenCount

CreatedTotalWOsCount

double CreatedTotalWOsCount

CreatedParentsCount

double CreatedParentsCount

CreatedChildrenCount

double CreatedChildrenCount

TerminatedTotalWOsCount

double TerminatedTotalWOsCount

TerminatedParentsCount

double TerminatedParentsCount

TerminatedChildrenCount

double TerminatedChildrenCount

CreationTotalRate

double CreationTotalRate

CreationParentRate

double CreationParentRate

CreationChildrenRate

double CreationChildrenRate

TerminationTotalRate

double TerminationTotalRate

TerminationParentRate

double TerminationParentRate

TerminationChildrenRate

double TerminationChildrenRate

GrowTotalRate

double GrowTotalRate

GrowParentRate

double GrowParentRate

GrowChildrenRate

double GrowChildrenRate

SumWOLifeSpan

double SumWOLifeSpan

SumParentLifeSpan

double SumParentLifeSpan

SumChildrenLifeSpan

double SumChildrenLifeSpan

AvgNumActiveWOs

double AvgNumActiveWOs

AvgNumActiveParents

double AvgNumActiveParents

AvgNumActiveChildren

double AvgNumActiveChildren

AvgLifeSpanWOs

double AvgLifeSpanWOs

AvgLifeSpanParents

double AvgLifeSpanParents

AvgLifeSpanChildren

double AvgLifeSpanChildren

SumActiveWOs

double SumActiveWOs

SumActiveParents

double SumActiveParents

SumActiveChildren

double SumActiveChildren

CurrentWOsCount

double CurrentWOsCount

CurrentParentsCount

double CurrentParentsCount

CurrentChildrenCount

double CurrentChildrenCount

Class filenet.vw.api.VWRouteDefinition extends filenet.vw.api.VWMLABase implements Serializable

serialVersionUID: 7505L

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.


description

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


attributes

VWAttributeInfo attributes
Array of attributes. The assignments are a set of left value and right value pairs.


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 that 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.


originalConnectorGraphicsInfosNode

java.lang.Object originalConnectorGraphicsInfosNode
When route is created from an XPDL file, a reference to the route's original ConnectorGraphicsInfos node in the XPDL DOM tree is saved here. Later if this route is output to an XPDL file, this ConnectorGraphicsInfo is added to the file. This object is defined as Object instead of its actual type Node (which requires importing org.w3c.dom.*) so that logic related to DOM trees stays in VWXMLHandler.java.

Class filenet.vw.api.VWRuleSetDefinition extends filenet.vw.api.VWMLABase implements Serializable

serialVersionUID: 7448L

Serialized Fields

m_Name

java.lang.String m_Name
The name of the ruleset.


m_Expensive

boolean m_Expensive
Expensive flag, allows the PE server to execute a rule asynchronously if the user indicates (by setting this flag) that the rule is long running (slow)


myWorkflow

VWWorkflowDefinition myWorkflow
A reference to the containing workflow definition object.

Class filenet.vw.api.VWSchema extends java.lang.Object implements Serializable

serialVersionUID: 470L

Serialized Fields

myWorkflow

VWWorkflowDefinition myWorkflow
A reference to the containing workflow definition object.


m_Name

java.lang.String m_Name

m_Schema

java.lang.String m_Schema

m_FileName

java.lang.String m_FileName

Class filenet.vw.api.VWSecurityDomain extends java.lang.Object implements Serializable

serialVersionUID: 468L

Serialized Fields

m_name

java.lang.String m_name

m_bNameCaseSensitive

boolean m_bNameCaseSensitive

m_formattedName

java.lang.String m_formattedName

Class filenet.vw.api.VWSecurityList extends java.lang.Object implements Serializable

serialVersionUID: 7491L

Serialized Fields

bufferSize

int bufferSize

fetchedObjects

java.lang.String[] fetchedObjects

idList

java.lang.Long[] idList

returnCount

int returnCount

fetchCount

int fetchCount

queryIsOver

boolean queryIsOver

lastRecord

java.lang.String lastRecord

listNameType

int listNameType

session

VWSession session

allUsers

java.util.Hashtable<K,V> allUsers

NCHServerName

java.lang.String NCHServerName

NCHServerDomain

java.lang.String NCHServerDomain

NCHServerOrganization

java.lang.String NCHServerOrganization

searchPattern

java.lang.String searchPattern

domain

java.lang.String domain

searchType

int searchType

sortType

int sortType

rpcArgFlag

long rpcArgFlag

Class filenet.vw.api.VWServerException extends VWException implements Serializable

serialVersionUID: 465L

Serialized Fields

hexTuple

java.lang.Long hexTuple
Hex representation of VWServer Error

See Also:
String

Class filenet.vw.api.VWSession extends java.lang.Object implements Serializable

serialVersionUID: 119619L

Serialized Fields

serviceName

java.lang.String serviceName

m_originalCPName

java.lang.String m_originalCPName

isolatedRegion

int isolatedRegion

auditFile

java.lang.String auditFile

auditOn

boolean auditOn

userName

java.lang.String userName

pw

java.lang.String pw

userInfo

VWUserInfo userInfo

numServers

int numServers

webAppId

int webAppId

queueNameCache

java.lang.String[] queueNameCache

rosterNameCache

java.lang.String[] rosterNameCache

cmdSession

filenet.vw.server.IPECommands cmdSession

NCHServerName

java.lang.String NCHServerName

NCHServerDomain

java.lang.String NCHServerDomain

NCHServerOrganization

java.lang.String NCHServerOrganization

wcConfigs

filenet.vw.server.VWConfigInfo[] wcConfigs

m_bootstrapCEURI

java.lang.String m_bootstrapCEURI

m_bootstrapConfigStream

java.io.InputStream m_bootstrapConfigStream

Class filenet.vw.api.VWSimpleInstruction extends VWInstructionDefinition implements Serializable

serialVersionUID: 7473L

Serialized Fields

params

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

Class filenet.vw.api.VWStepDefinition extends VWMapNode implements Serializable

serialVersionUID: 119072L

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.


canViewHistory

boolean canViewHistory
Flag to indicate whether history can be viewed at this step by the step processor.


ignoreInvalidUsers

boolean ignoreInvalidUsers
Flag to indicate whether to ignore invalid users/participants when a step is reached at runtime.


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

java.lang.String deadline
WAS : Long - 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. CAN ALSO NOW BE : A String, expression of type time, For backward compatibility we allow an integer literal as described above. Integer literal values will be special handled following the above semantics, e.g, 45 means 45 minutes after work starts. A value of null means no deadline.


deadlineMap

java.lang.String deadlineMap
Name of a map to be called when a deadline expires.


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.


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 extends filenet.vw.api.VWWorkElement implements Serializable

serialVersionUID: 119106L

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


myStepDef

VWStepDefinition myStepDef
Reference to the containing Step definition object


processId

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


NewWorkflowNumber

java.lang.String NewWorkflowNumber

NewWorkSpaceId

int NewWorkSpaceId

serviceSession

VWSession serviceSession

Class filenet.vw.api.VWStepPaletteDefinition extends java.lang.Object implements Serializable

serialVersionUID: 471L

Serialized Fields

m_name

java.lang.String m_name

m_description

java.lang.String m_description

m_mapNodes

VWMapNode[] m_mapNodes

m_mapNodesHandler

filenet.vw.api.VWArrayHandler m_mapNodesHandler

m_mapNodeIdGenerator

filenet.vw.api.VWIdGenerator m_mapNodeIdGenerator

Class filenet.vw.api.VWStepProcessorInfo extends filenet.vw.api.VWStepProcessorObject implements Serializable

serialVersionUID: 7472L

Class filenet.vw.api.VWStepProcessorInfoDefinition extends filenet.vw.api.VWStepProcessorObject implements Serializable

serialVersionUID: 7465L

Serialized Fields

alreadyTransferred

boolean alreadyTransferred

Class filenet.vw.api.VWSystemConfiguration extends java.lang.Object implements Serializable

serialVersionUID: 7555L

Serialized Fields

maxDBOperations

int maxDBOperations

maxInstructions

int maxInstructions

bStatisticsCollectionOn

boolean bStatisticsCollectionOn

bTrackAttachmentReferences

boolean bTrackAttachmentReferences

theLoggingOptions

int theLoggingOptions

bHasChanged

boolean bHasChanged

serviceSession

VWSession serviceSession

systemConfig

filenet.vw.server.VWSystemConfigInfo systemConfig

defaultLogDef

VWLogDefinition defaultLogDef

serverIDs

java.lang.Integer[] serverIDs

QDefHandler

filenet.vw.api.VWArrayHandler QDefHandler

theQDefs

VWQueueDefinition[] theQDefs

mandatoryQExpFields

VWExposedFieldDefinition[] mandatoryQExpFields

mandatoryQIndexes

VWIndexDefinition[] mandatoryQIndexes

RDefHandler

filenet.vw.api.VWArrayHandler RDefHandler

theRDefs

VWRosterDefinition[] theRDefs

mandatoryRExpFields

VWExposedFieldDefinition[] mandatoryRExpFields

mandatoryRIndexes

VWIndexDefinition[] mandatoryRIndexes

LDefHandler

filenet.vw.api.VWArrayHandler LDefHandler

theLDefs

VWLogDefinition[] theLDefs

mandatoryLExpFields

VWExposedFieldDefinition[] mandatoryLExpFields

mandatoryLIndexes

VWIndexDefinition[] mandatoryLIndexes

SPDefHandler

filenet.vw.api.VWArrayHandler SPDefHandler

theSPDefs

VWStepProcessorInfoDefinition[] theSPDefs

DeletedSPDefHandler

filenet.vw.api.VWArrayHandler DeletedSPDefHandler

theDeletedSPDefs

VWStepProcessorInfoDefinition[] theDeletedSPDefs

ApplicationSpaceDefHandler

filenet.vw.api.VWArrayHandler ApplicationSpaceDefHandler

theApplicationSpaceDefs

VWApplicationSpaceDefinition[] theApplicationSpaceDefs

attributes

java.util.Hashtable<K,V> attributes
Hashtable of attributes. The assignments are a set of left value and right value pairs.


isSelectedForExport

boolean isSelectedForExport

Class filenet.vw.api.VWTableDefinition extends filenet.vw.api.VWMLABase implements Serializable

serialVersionUID: 7570L

Serialized Fields

name

java.lang.String name

serverId

int serverId

bHasChanged

boolean bHasChanged

theFieldDefs

VWExposedFieldDefinition[] theFieldDefs

theFieldsHandler

filenet.vw.api.VWArrayHandler theFieldsHandler

theIndexDefs

VWIndexDefinition[] theIndexDefs

theIndexHandler

filenet.vw.api.VWArrayHandler theIndexHandler

readSecurity

java.lang.String[] readSecurity

writeSecurity

java.lang.String[] writeSecurity

readSecurityPx

VWParticipant[] readSecurityPx

writeSecurityPx

VWParticipant[] writeSecurityPx

description

java.lang.String description

attributes

java.util.Hashtable<K,V> attributes
Hashtable of attributes. The assignments are a set of left value and right value pairs.


configType

int configType

ALLOW_ORB_TO_SET_SERVERID_TO_ALL_SERVERS

int ALLOW_ORB_TO_SET_SERVERID_TO_ALL_SERVERS
Hack to allow orb to set servers - used in setServerId()


isSelectedForExport

boolean isSelectedForExport

Class filenet.vw.api.VWTextAnnotationDefinition extends java.lang.Object implements Serializable

serialVersionUID: 464L

Serialized Fields

myMap

VWMapDefinition myMap
A reference to the containing Map definition object.


associations

java.util.Vector<E> associations
Collection of associations for this annotation (i.e. the things that this annotation points to)


id

int id
Annotation id, unique within a map.


location

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

See Also:
Point

message

java.lang.String message
Message text.


dim

java.awt.Dimension dim
dimension, can be null. May be used by UI to display the text message, will be persisted to the pep file.


minimized

boolean minimized
minimized, boolean flag. May be used by UI to display the message, will be persisted to the pep file.


color

java.awt.Color color
color. May be used by UI to display the message, will be persisted to the pep file.


name

java.lang.String name
Name. The name property of this annotation.


originalNodeGraphicsInfosNode

java.lang.Object originalNodeGraphicsInfosNode
When a TextAnnotation is created from an XPDL file, a reference to the TextAnnotation's original NodeGraphicsInfos node in the XPDL DOM tree is saved here. Later if this TextAnnotation is output to an XPDL file, the NodeGraphicsInfo from other other (non-FileNet) applications can be added to the file. This object is defined as Object instead of its actual type Node (which requires importing org.w3c.dom.*) so that logic related to DOM trees stays in VWXMLHandler.java.

Class filenet.vw.api.VWTransferResult extends java.lang.Object implements Serializable

serialVersionUID: 7443L

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.VWUserInfo extends java.lang.Object implements Serializable

serialVersionUID: 7536L

Serialized Fields

emailAddress

java.lang.String emailAddress
The e-mail address for this user.


userPx

VWParticipant userPx

notificationFlags

int notificationFlags
The notification flags. The flags are OR'd together to form this value.


serverIdAssignment

int serverIdAssignment
The server ID to which this user is assigned.


systemString

java.lang.String systemString
Start of system reserved fields.


fieldsHash

java.util.Hashtable<K,V> fieldsHash
Hash fields.


serviceSession

VWSession serviceSession
The VWSession object necessary for calling commands on the server.


timeStamp

long timeStamp
The time stamp for this data. This is returned from the VWEnvironmentData information during the fetch.


FEMailAddress

java.lang.String FEMailAddress

FNotificationFlags

java.lang.String FNotificationFlags

FDefaultServerId

java.lang.String FDefaultServerId

FUserProxyId

java.lang.String FUserProxyId

FPreferredLocale

java.lang.String FPreferredLocale

proxyUserPx

VWParticipant proxyUserPx

proxyUserId

int proxyUserId

preferredLocale

java.util.Locale preferredLocale
Locale to be used for email notification for this user.

Class filenet.vw.api.VWWebServiceParameterDefinition extends filenet.vw.api.VWMLABase implements Serializable

serialVersionUID: 7449L

Serialized Fields

m_Name

java.lang.String m_Name

m_Mode

int m_Mode

m_DataType

int m_DataType

m_bIsArray

boolean m_bIsArray

m_Value

java.lang.String m_Value

m_NameSpace

java.lang.String m_NameSpace

m_Attributes

java.lang.String m_Attributes

m_ArrayTag

java.lang.String m_ArrayTag

m_ArrayNameSpace

java.lang.String m_ArrayNameSpace

m_ArrayAttributes

java.lang.String m_ArrayAttributes

m_LexicalLevel

int m_LexicalLevel

m_bAttachmentByValue

boolean m_bAttachmentByValue

m_SchemaSubType

int m_SchemaSubType

m_Sequence

int m_Sequence

m_MyInstruction

VWInstructionDefinition m_MyInstruction
A reference to the containing instruction definition, used for validation.

Class filenet.vw.api.VWWFEInstruction extends VWInstructionDefinition implements Serializable

serialVersionUID: 7461L

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 forever.


eventNumLoc

java.lang.String eventNumLoc
A numeric Lvalue expression that 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.VWWorkBasket extends VWQueueQuery implements Serializable

serialVersionUID: 7424L

Serialized Fields

columns

VWWorkBasket.Column[] columns

nColumns

int nColumns

filters

VWWorkBasket.Filter[] filters

nFilters

int nFilters

wbDef

VWWorkBasketDefinition wbDef

qName

java.lang.String qName

session

VWSession session

m_desc

java.lang.String m_desc

Class filenet.vw.api.VWWorkBasket.Column extends java.lang.Object implements Serializable

serialVersionUID: 7424L

Serialized Fields

columnDef

VWWorkBasketColumnDefinition columnDef

m_desc

java.lang.String m_desc

Class filenet.vw.api.VWWorkBasket.Filter extends java.lang.Object implements Serializable

serialVersionUID: 7424L

Serialized Fields

filter

VWWorkBasketFilterDefinition filter

m_desc

java.lang.String m_desc

Class filenet.vw.api.VWWorkBasket.QueryResults extends java.lang.Object implements Serializable

serialVersionUID: 7424L

Serialized Fields

wobs

filenet.vw.api.VWWorkElement[] wobs

lastRecord

java.lang.String lastRecord

queryChars

java.lang.String queryChars

m_desc

java.lang.String m_desc

Class filenet.vw.api.VWWorkBasketColumnDefinition extends filenet.vw.api.VWMLABase implements Serializable

serialVersionUID: 7440L

Serialized Fields

m_prompt

java.lang.String m_prompt

m_column

VWExposedFieldDefinition m_column

m_bIsSortable

boolean m_bIsSortable

m_indexName

java.lang.String m_indexName

m_ORBColumnName

java.lang.String m_ORBColumnName

m_type

int m_type

m_attributes

java.util.Hashtable<K,V> m_attributes
Hashtable of attributes. The assignments are a set of left value and right value pairs.

Class filenet.vw.api.VWWorkBasketDefinition extends filenet.vw.api.VWMLABase implements Serializable

serialVersionUID: 7464L

Serialized Fields

m_myQueueName

java.lang.String m_myQueueName

m_name

java.lang.String m_name

m_description

java.lang.String m_description

m_indexName

java.lang.String m_indexName

m_queryFilterString

java.lang.String m_queryFilterString

m_workBasketColumnDefs

VWWorkBasketColumnDefinition[] m_workBasketColumnDefs
Array of work basket column definitions.


m_workBasketColumnDefHandler

filenet.vw.api.VWArrayHandler m_workBasketColumnDefHandler

m_workBasketFilterDefs

VWWorkBasketFilterDefinition[] m_workBasketFilterDefs
Array of work basket filter definitions.


m_workBasketFilterDefHandler

filenet.vw.api.VWArrayHandler m_workBasketFilterDefHandler

m_attributes

java.util.Hashtable<K,V> m_attributes
Hashtable of attributes. The assignments are a set of left value and right value pairs.


m_nRevision

int m_nRevision

m_nObjId

int m_nObjId

m_bHasChanged

boolean m_bHasChanged

Class filenet.vw.api.VWWorkBasketFilterDefinition extends filenet.vw.api.VWMLABase implements Serializable

serialVersionUID: 7449L

Serialized Fields

m_name

java.lang.String m_name

m_description

java.lang.String m_description

m_prompt

java.lang.String m_prompt

m_searchField

VWExposedFieldDefinition m_searchField

m_operator

int m_operator

m_orbFieldName

java.lang.String m_orbFieldName

m_type

int m_type

m_attributes

java.util.Hashtable<K,V> m_attributes
Hashtable of attributes. The assignments are a set of left value and right value pairs.

Class filenet.vw.api.VWWorkflowCollectionDefinition extends java.lang.Object implements Serializable

serialVersionUID: 119125L

Serialized Fields

description

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


name

java.lang.String name
The name of this workflow collection. May be null.


authorTool

java.lang.String authorTool
A String that can be used to identify the application that generated this workflow definition. Can be null or a String like "designer 2.5", intended use is so that an app like designer could know that a workflow definition was generated by a different application, such as egrail or brightspire process designers.


workflows

VWWorkflowDefinition[] workflows
An array of workflow definitions for this workflow collection.

See Also:
VWWorkflowDefinition

workflowsHandler

filenet.vw.api.VWArrayHandler workflowsHandler
A helper to manage the workflow definitions for this workflow collection.


mainWorkflow

VWWorkflowDefinition mainWorkflow
The "main" workflow in this collection. The "main" workflow is the one that will be launched if the workflow collection is launched.


applicationSpaceName

java.lang.String applicationSpaceName
The name of this workflow collection. May be null.


originalPoolsNode

java.lang.Object originalPoolsNode
When a workflow collection is created from an XPDL file, a reference to the original Pools node in the XPDL DOM tree is saved here. Later if this workflow collection is output to an XPDL file, the Pools info is added to the file. This object is defined as Object instead of its actual type Node (which requires importing org.w3c.dom.*) so that logic related to DOM trees stays in VWXMLHandler.java.


packageAttributes

java.lang.String[] packageAttributes
When a workflow collection is created from an XPDL file, the package attributes are saved here. Later if this workflow collection is output to an XPDL file, the any extra name-space attributes are added to the Package.


scenarioDefinitionsNode

java.lang.Object scenarioDefinitionsNode
When an XPDL file is parsed, it may contain scenario definition nodes. The necessary classes to parse these nodes may not be available. We need to save these nodes so that if this workflow collection is output to an XPDL file, the Scenario Definition info is added to the file. This object is defined as Object instead of its actual type Node (which requires importing org.w3c.dom.*) so that the logic related to DOM trees stays in VWXMLHandler.java.


scenarioCollectionDefinition

filenet.vw.api.IVWCollectionExtension scenarioCollectionDefinition
This is a "loose" reference to a class in the filenet.sim.api package that may not always be available.

See Also:
#registerCollectionExtension()

source

int source
Indicates where the source of the workflow collection: from an XPDL file, a PEP file, or from nothing (new).

Class filenet.vw.api.VWWorkflowDefinition extends filenet.vw.api.VWMLABase implements Serializable

serialVersionUID: 119123L

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.


myWorkflowCollection

VWWorkflowCollectionDefinition myWorkflowCollection
A reference to the containing workflow collection definition object. Will be null for a standalone 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 workflow Definition. May be null. The name will be used to make part of the WorkClass name when the workflow definition is transferred.


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 work class 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.


authorTool

java.lang.String authorTool
A String that can be used to identify the application that generated this workflow definition. Can be null or a String like "designer 2.5", intended use is so that an app like designer could know that a workflow definition was generated by a different application, such as egrail or brightspire process designers.


tag

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


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
Long - 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.


disableEmailNotification

boolean disableEmailNotification
The user can disable email notification for the workflow.


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.


partnerLinks

VWPartnerLinkDefinition[] partnerLinks
An array of partner link definitions for this workflow.

See Also:
VWPartnerLinkDefinition

partnerLinkHandler

filenet.vw.api.VWArrayHandler partnerLinkHandler
A helper to manage the partner link definitions for this workflow definition.


schemas

VWSchema[] schemas
An array of schema definitions for this workflow.

See Also:
VWSchema

schemaHandler

filenet.vw.api.VWArrayHandler schemaHandler
A helper to manage the schema definitions for this workflow definition.


ruleSets

VWRuleSetDefinition[] ruleSets
An array of rule set definitions for this workflow.

See Also:
VWRuleSetDefinition

ruleSetsHandler

filenet.vw.api.VWArrayHandler ruleSetsHandler
A helper to manage the rule set 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 work class 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

VWAttributeInfo attributes
Array of attributes. The assignments are a set of left value and right value pairs.


runtimeId

VWWorkflowRuntimeId runtimeId
The runtime ID of the workflow definition. Runtime ids are only valid for workflow definitions that have been retrieved from the server.


incomingWSAttachmentFolder

java.lang.String incomingWSAttachmentFolder
The toString form of an attachment which specifies a folder that will be used to store incoming Web services attachments (e.g. attachments from a receive instruction)


versionAgnostic

boolean versionAgnostic
flag, if true, WSDL generation doesn't care about version of the workflow when calculating the correlation set.


validateUsingSchema

boolean validateUsingSchema
flag, if true, server will validate process orchestration messages at runtime using schema.


validateFlag

boolean validateFlag
If this workflow is part of a VWWorkflowCollectionDefintion, this property provides control over the validation of individual VWWorkflowDefinitions within the VWWorkflowCollectionDefintion.


transferFlag

boolean transferFlag
If this workflow is part of a VWWorkflowCollectionDefintion, this property provides control over the transfer of individual VWWorkflowDefinitions within the VWWorkflowCollectionDefintion.


originalId

java.lang.String originalId
When an XPDL file containing Pools is read, a reference to the original Pools node in the XPDL DOM tree is saved in the workflow collection. Later if this workflow collection is output to an XPDL file, the Pools info is added to the file. Each Pool element can contain the Id of a WorkflowProcess that appears in the Pool. These Ids are not the same as the ones generated when the workflow collection is output to an XPDL file. Therefore, we preserve the original Id here and modify the Pool Process Ids on output.

Class filenet.vw.api.VWWorkflowRuntimeId extends java.lang.Object implements Serializable

serialVersionUID: 7443L

Serialized Fields

m_serviceName

java.lang.String m_serviceName

m_id

java.lang.String m_id

m_timeStamp

java.util.Date m_timeStamp

m_region

int m_region

m_wcId

int m_wcId

m_wcRevision

int m_wcRevision

m_wsId

int m_wsId

m_WSDLVersion

int m_WSDLVersion

Class filenet.vw.api.VWWorkflowSignature extends filenet.vw.api.VWMLABase implements Serializable

serialVersionUID: 7474L

Serialized Fields

transferUserPx

VWParticipant transferUserPx

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

iSheetIds

int[] iSheetIds

serviceSession

VWSession serviceSession

rosterName

java.lang.String rosterName

eventLogName

java.lang.String eventLogName

description

java.lang.String description

MilestoneNames

java.lang.String[] MilestoneNames

RulesetNames

java.lang.String[] RulesetNames

PartnerlinkNames

java.lang.String[] PartnerlinkNames

schemaNames

java.lang.String[] schemaNames

name

java.lang.String name

workSpaceId

int workSpaceId

hasMyPortType

boolean hasMyPortType

baseWorkClassName

java.lang.String baseWorkClassName

versionAgnostic

boolean versionAgnostic

Class filenet.vw.api.VWWorkObject extends filenet.vw.api.VWWorkElement implements Serializable

serialVersionUID: 119077L

Serialized Fields

workFlowId

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

Class filenet.vw.api.VWWorkObjectNumber extends java.lang.Object implements Serializable

serialVersionUID: 470L

Serialized Fields

workObjectNumber

java.lang.String workObjectNumber
The work object number

Class filenet.vw.api.VWXMLData extends java.lang.Object implements Serializable

serialVersionUID: 464L

Serialized Fields

m_XML

java.lang.String m_XML

m_SchemaName

java.lang.String m_SchemaName

m_ElementName

java.lang.String m_ElementName

m_isRuntime

boolean m_isRuntime


Process API

© Copyright IBM Corporation 2002, 2008. All rights reserved.