Process Class Relationships

Package filenet.vw.api

Interface Summary
IVWField The IVWField class provides a definition for field values.
IVWTableDefinition The VWTableDefinition class provides the definition for database tables.
IVWtoXML The IVWtoXML provides a way to identify which VW api objects implement toXML() methods.
 

Class Summary
VWActionType This class defines constants to represent various actions that can be used in a compound step definition and accesses fundamental information about these actions.
VWAttachment Use this class to access the identity, associated library or object store, type, Document ID, and version series of an attachment used in a workflow process.
VWAttachmentType Use this class to access the type information for an attachment.
VWAttributeInfo VWAttributeInfo objects contain a set of name-value pairs; the VWAttributeInfo class enables users to associate properties they define with VWOperationDefinition, VWQueueDefinition, VWStepDefinition, VWSystemAdministration, VWSystemConfiguration, and VWWorkflowDefinition objects.
VWCompoundStepDefinition The VWCompoundStepDefinition class creates, deletes, and orders a series of workflow map nodes that execute various action types of workflow system instructions. Use the VWCompoundStepDefinition class to access timers, to make calls to sub-maps (instruction sheets), and to perform additional workflow map functions shown in the method summary.
VWCreateLiveWOResult Use this class to access the return value of a VWSession.createLiveWorkObject() method call.
VWDataField Use this class to access a workflow object data field.
VWEventDefinition The VWEventDefinition class encapsulates methods and data that define events. Events are used in the Wait For Event instructions (class VWWFEInstruction) of a compound step definition.
VWExposedFieldDefinition Use this class to designate specific search fields for roster, queue, and log classes.
VWFetchType Use this class to determine the fetch type and retrieve a string version of the type.
VWFieldDefinition Use this class to access a field definition object, which is the authoring-time representation of a field in a workflow.
VWFieldType Use this class to determine the data field types available in a workflow.
VWIndexDefinition Use this class to define an index that contains concatenated field names--names which consist of the exposed or system fields. Arrays are not allowed.
VWInjectSessionInfo Deprecated. Replaced by VWSession.createLiveWorkObject(String[], Object[], String, int), which produces an instance of VWCreateLiveWOResult.
VWInstructionDefinition This class represents an individual instruction within a compound step definition.
VWInstructionElement Use this class to access the current operation on a workflow object, along with the operation parameters.
VWJoinType Use this class to access the join type for branching of the workflow. The join type is a property of a step in a workflow graph which has multiple execution routes.
VWLibraryType Use this class to determine whether the library or Object Store type is Image Services, Content Services, or undefined.
VWLog Use this class to query logs, determine the associated session, and access the log definition.
VWLogDefinition VWLogDefinition administers properties of event log definitions for the default event log and roster event logs.
VWLogElement Use this class to retrieve log element information.This class contains the information on the event log record.
VWLoggingOptionType Use this class to set the option type for logging a message on the server.
VWLogQuery Use this class to query for log elements.
VWMapDefinition Use this class to access workflow steps and properties of the Workflow Map.
VWMapNode VWMapNode is an abstract base class which encapsulates the routing, location, and other properties that relate to the of steps of a map.
VWMergeType Use this class to get the merge type for data fields.
VWMilestoneDefinition Use this class to access the name, message, level, and other properties of a milestone used in a workflow process.
VWMilestoneElement Use this class to encapsulate a milestone log record.
VWModeType Use this class to specify a directional attribute of an object such as, for example, a parameter of an operation or a step.
VWNewWorkObject Deprecated. Not Replaced
VWNodeType Use this class to classify the nodes on a map into the following categories:
VWOperationDefinition A VWOperationDefinition object specifies an operation within a queue that performs a specific task. The definition includes the operation name, a set of parameters needed to perform the operation, and an optional description.
VWOperationType Use this class to determine the operation type for a step.
VWParameter Use this class to access the parameter values for a step.
VWParameterDefinition Use this class to access the definition object for a parameter.
VWParticipant A VWParticipant object represents a user or user group name.
VWParticipantHistory Use this class to access the participant history for a step element.
VWProcess Use this class to access information about an executing workflow, such as status, history, or child/split work object information.
VWQueue Use this class to access the contents of a queue.
VWQueueDefinition Use this class to administer queue definitions.
VWQueueElement Accesses queue fields and Instruction Elements of a workflow object associated with a queue.
VWQueueQuery Use this class to query for queue elements, work objects, or Instruction elements.
VWQueueStats Use this class to encapsulate the statistical results for a queue.
VWReturnStackElement Encapsulates a stack frame object for a work object, containing map and step identification and error description information.
VWRollbackInstruction This class encapsulates rollback instructions for a compound step definition.
VWRoster Use this class to access the contents of a roster or manage running workflows.
VWRosterDefinition Use the VWRosterDefinition class to retrieve and administer roster definition information.
VWRosterElement Use this class to access a roster element and fetch a work object or an instruction element.
VWRosterQuery Use this class to query roster elements or work objects.
VWRosterStats Use this class to retrieve roster statistics.
VWRouteDefinition Use this class to access an object that represents the workflow authoring-time definition of a route.
VWRuleSetDefinition This class encapsulates a ruleset object, which enables business rules to be independently applied to workflows.
VWSecurityList Use this class to query for a security list.
VWSession Use this class to establish a session and log onto a Process Engine.
VWSimpleInstruction The VWSimpleInstruction class encapsulates simple instructions in a compound step definition. In this implementation, every instruction except Rollback and WaitForEvent can be represented by a VWSimpleInstruction object.
VWSplitType Use this class to access the split type for branching of the workflow. The split type is a property of a step in a workflow graph which has multiple execution routes.
VWStepDefinition Use this class to access a step definition object: to create, delete, or modify step properties.
VWStepElement Use this class to access a step in a workflow process.
VWStepHistory Use this class to query for a step history.
VWStepOccurrenceHistory Use this class to query the step occurrence history of work objects for a step.
VWStepProcessorInfo Use this class to access properties of the step processor object that are useful for launching a step, such as its dimensions, processor name and type, and Web application location.
VWStepProcessorInfoDefinition Use this class' methods to administer Step Processor information. Create this object with VWSystemConfiguration.createStepProcessorInfoDefinition().
VWStepWorkObjectHistory Use this class to query the participant histories of a step occurrence history item.
VWSystemAdministration Use this class to access and modify system-wide administration information or tasks.
VWSystemConfiguration Use this class to access configuration information for an isolated region.
VWTimeUnitType Use this class to define the time unit types used in computing statistical results.
VWTransferResult Use this class to access the value returned by a VWSession.transfer() method call.
VWUserInfo Use this class to access information for a specific user.
VWValidationError Use this class to access information about errors encountered during the workflow definition validation process.
VWWFEInstruction This class encapsulates wait for event instructions in a compound step definition.
VWWorkflowDefinition Use this class to create, delete, and access a workflow definition object and its sub-objects.
VWWorkflowHistory Use this class to query step history information.
VWWorkflowMilestones Queries for workflow milestone occurrences in the workflow log.
VWWorkflowRuntimeId This class designates a workflow runtime ID for a workflow definition that has been transferred and compiled.
VWWorkflowSignature This class designates a workflow signature after it is transferred and compiled, but before it becomes an executing workflow process.
VWWorkObject Use this class to access all data fields in a work object and fetch Instruction Element information associated with the work object.
VWXMLUtil VWXMLUtil creates and processes blocks of XML.
 

Exception Summary
VWException This is the base class for all workflow exceptions.
VWServerException This is the base class for all workflow exceptions.
 



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