Process API

Uses of Package
filenet.vw.api

Classes in filenet.vw.api used by filenet.vw.api
IVWField
          The IVWField class provides a definition for field values.
IVWPastable
          Catagorizes classes that can be pasted into a map.
IVWTableDefinition
          The VWTableDefinition class provides the definition for database tables.
IVWtoXML
          Provides a way to identify which objects implement a toXML() method.
VWApplicationSpaceDefinition
          Use this class to create, read, delete, or modify application space properties.
VWAssociationDefinition
          Represents a connection from a text annotation in a map to a route or a node (step) in the same map.
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.
VWAttachmentTrackingQuery
          Use this class to query for roster elements that reference a specific 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
          Use this class to create, delete, and order a series of workflow map nodes to execute various action types of workflow system instructions.
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.
VWException
          This is the base class for all workflow exceptions. Use this class to access the resource strings an application uses to create the exceptions.
VWExposedFieldDefinition
          Use this class to designate specific search fields for roster, queue, and log classes.
VWFaultDefinition
          Use the VWFaultDefinition class to retrieve and set the name, map name (optional), and message for a Web Services fault, represented by a VWFaultDefinition object. Additional functions of methods in this class include validating a fault or converting a fault into an XML String.
VWFieldDefinition
          Use this class to access a field definition object, which is the authoring-time representation of a field 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.
VWInstructionDefinition
          This class represents an individual instruction within a compound step definition.
VWInstructionElement
          Deprecated. Replaced by VWStepElement
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, which is retrieved from the event log record.
VWLogQuery
          Use this class to query for log elements.
VWMapDefinition
          Use this class to access workflow steps and properties of the workflow map.
VWMapNode
          An abstract base class that encapsulates the routing, location, and other properties related to the steps of a map.
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.
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.
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
          Use this class to represent the name of a user or user group in any of the following ways: "Short" (logon) name Distinguished name (DN) Display name (configurable)
VWParticipantHistory
          Use this class to access the participant history for a step element.
VWParticipantList
          Use the VWParticipantList class to query a list of participants (VWParticipant objects).
VWPartnerLinkDefinition
          Use this class to access name, port type, role, endpoint, and other properties of a partner link used in a workflow process.
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.
VWRole
          Use this class to retrieve information about a role.
VWRole.WorkBasketReference
          Use this class to retrieve information about a workbasket associated with a role.
VWRoleDefinition
          Use this class to create, read, delete, or modify role definition properties.
VWRoster
          Use this class to access the contents of a roster or manage running workflows.
VWRosterDefinition
          Use the VWRosterDefinition.java 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
          Enables business rules to be independently applied to workflows.
VWSchema
          This class represents an XML schema that can be a property of a workflow definition.
VWSecurityDomain
          This class represents a Process Engine security domain.
VWSecurityList
          Use the VWSecurityList class to query a list of user objects.
VWSession
          Use this class to establish a session and log onto a Process Engine.
VWStepDefinition
          Use this class 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.
VWStepPaletteDefinition
          This class encapsulates a step palette
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.
VWTableDefinition
          Defines database tables for use with queues, rosters, and logs.
VWTextAnnotationDefinition
          Represents a text annotation in a map.
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.
VWWebServiceParameterDefinition
          Use this class to access the definition object for a web service parameter.
VWWorkBasket
          Use this class to retrieve information about a workbasket, its columns, filters, or query results.
VWWorkBasket.Column
          Represents a read-only, runtime column for the workbasket.
VWWorkBasket.Filter
          Represents a read-only, runtime filter for the workbasket.
VWWorkBasket.QueryResults
          Represents the query result as returned by the fetchNextBatch method.
VWWorkBasketColumnDefinition
          Use this class to create, read, delete, or modify workbasket column definition properties.
VWWorkBasketDefinition
          Use this class to create, read, delete, or modify work basket definition properties.
VWWorkBasketFilterDefinition
          Use this class to create, read, delete, or modify work basket filter definition properties.
VWWorkflowCollectionDefinition
          Represents zero or more workflow definitions.
VWWorkflowDefinition
          Use this class to create, delete, and access a workflow 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, which represents a work class on the Process Engine after it has been transferred, 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.
 


Process API

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