Package filenet.vw.api

  • Interface Summary 
    Interface Description
    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.
  • Class Summary 
    Class Description
    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.
    VWApplicationSpace
    Use this class to retrieve information about an Application Space.
    VWApplicationSpaceDefinition
    Use this class to create, read, delete, or modify application space properties.
    VWAppNotificationTemplateList
    This class contains the e-mail notification template files for one web application.
    VWAssociationDefinition
    Represents a connection from a text annotation in a map to a route or a node (step) in the same map.
    VWAssociationTargetType
    Specifies whether the type of target an association references is a node (step) or route in a 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.
    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
    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.
    VWDBExecuteConnection
    This object contains the information needed by workflow system to access a remote database and execute one or more stored procedures.
    VWDynamicLaunchResult
    This class contains the results of launching a dynamic workflow, which includes the results of the transfer of the Workflow definition, and the results of creating the work object.
    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.
    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.
    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.
    VWGuid
    Use this class only as a substitution value type for queries.
    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.
    VWInstructionDefinition
    This class represents an individual instruction within a compound step definition.
    VWInstructionElement Deprecated
    Replaced by VWStepElement
    VWInvokeInstruction
    Use this class to invoke an external Web Service.
    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.
    VWLanguagePack
    This class encapsulates a language pack, which contains information the PE server uses to generate e-mail notification messages.
    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, which is retrieved from 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
    An abstract base class that encapsulates the routing, location, and other properties related to the 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.
    VWNodeType
    Use this class to classify the nodes on a map into the following categories:
    VWNotificationSettings
    This class encapsulates the definition of e-mail notification settings used by the PE server.
    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
    Use this class to represent the name of a user or user group in any of the following ways:
    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.
    VWProcessStoreInitStruct
    This class is used to bootstrap a Workflow System (which will also create a new isolated region) or add a new isolated region to an existing Workflow System.
    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 Deprecated
    This class has been deprecated since BPM release 4.0.
    VWRDBObjectDefinition
    This class encapsulates the definition of a relational database object.
    VWReceiveInstruction
    This class represents a Process Engine workflow step instruction that allows a Process Engine to communicate through a local web service listener and receive either an XML message or a set of Process Engine workflow operation parameters.
    VWRegionAdministration
    This class provides functions to administer a Workflow System's isolated region.
    VWRegionFieldDefinition
    Use this class to create, read, delete, or modify Region Field definition properties.
    VWRegionFieldList
    Use this class to create, read, delete, or modify region field definition lists.
    VWReplyInstruction
    This class defines a workflow step instruction that allows a Process Engine to communicate through a local Web Service and send a reply XML message to a location defined by the associated partner link, or it may send parameters to this location.
    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.
    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.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 Deprecated
    This class has been deprecated since BPM release 4.0.
    VWRouteDefinition
    Use this class to access an object that represents the workflow authoring-time definition of a route.
    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.
    VWServerInstanceSettings
    This class contains the custom settings for a PE server instance.
    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.
    VWSLADefinition
    Use this class to create, read, delete, or modify Service Level Agreement definition properties.
    VWSLAEntryDefinition
    Use this class to create, read, delete, or modify Service Level Agreement Entry definition properties.
    VWSLAList
    Use this class to create, read, delete, or modify Service Level Agreement definition lists.
    VWSpecialDayDefinition
    Use this class to create, read, delete, or modify Special day definition properties.
    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 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.
    VWTimeIntervalDefinition
    Use this class to create, read, delete, or modify Time Interval definition properties.
    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.
    VWWebServiceParameterDefinition
    Use this class to access the definition object for a web service parameter.
    VWWFEInstruction
    This class encapsulates wait for event instructions in a compound step definition.
    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
    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.
    VWWorkDayDefinition
    Use this class to create, read, delete, or modify Work Day 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.
    VWWorkflowResults
    Container used to fetch dynamic workflow definitions.
    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.
    VWWorkObjectNumber
    Use this class only as a substitution value type for queries.
    VWWorkScheduleDefinition
    Use this class to create, read, delete, or modify work schedule definition properties.
    VWWorkScheduleList
    Use this class to create, read, delete, or modify Work Schedule definition lists.
    VWXLIFFDefinition
    Use this class to create, read, delete, or modify XLIFF definitions for different locales within a region
    VWXLIFFList
    Use this class to create, read, delete, or modify XLIFF definition items.
    VWXMLConfiguration
    VWXMLConfiguration imports and exports XML text representing Process Engine administration and configuration objects that implement the IVWtoXML interface.
    VWXMLData
    Use this class to retrieve or set schemas, elements, and XML Strings for the workflow fields that are the XML data fields for Web Services.
    VWXMLRegionMetadata
    This class is used to facilitate import and export of the isolated region metadata XML text.
    VWXMLSchemaSubType
    This class defines constants to represent various tyeps that can be used in generating or interpreting WSDL files used in web services operations.
    VWXMLUtil
    VWXMLUtil creates and processes blocks of XML from Process Engine API runtime objects that implement the IVWtoXML interface.
  • Exception Summary 
    Exception Description
    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.
    VWServerException
    This is the base class for all workflow exceptions.

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