# Package com.ibm.openpages.api.workflow

Provides interfaces to work with native workflow system.

See: Description

- Interface Summary
  Interface | Description
  --- | ---
  IEvaluationContext | Represents context object when the `IWFEvalUnit` is evaluated for the workflow operations and beyond.
  IWFAction | Represents the workflow action configured on the process definition
  IWFActivity | Interface that represents an activity definition.
  IWFActivityInstance | Interface that represents an activity instance.
  IWFActivityInstanceFindOptions | Represents options for `IWorkflowService.getActivityInstances(IWFActivityInstanceFindOptions)`.
  IWFActivityNotification | Interface that represents workflow activity notification instances, created as required when the activity is triggered
  IWFActivityNotificationDefinition | Interface that represents workflow activity notification definition.
  IWFActivityNotificationFindOptions | Represents options for retrieving `IWFActivityNotification`s using the `IWorkflowService.getActivityNotifications(IWFActivityNotificationFindOptions)` method.
  IWFAdvancedLogicConditionEval | Interface that represents a grouping of conditions, joined by advanced logic operations such as AND, OR, NOT, and condition grouping using parentheses.
  IWFBaseFindOptions | Base interface for workflow object fetching options.
  IWFCalculationEval | Interface that represents a calculation based on an expression
  IWFConditionEval | Interface that represents conditions which are defined on process definitions, and are evaluated in the context of process instances
  IWFConditionGroupEval | Interface that represents condition group which is defined on process definition, and is evaluated in the context of process instance.
  IWFCurrencyEval | Interface that represents currency value evaluation unit.
  IWFDateEval | Interface that represents date evaluation in the context of process instance.
  IWFEvalUnit | Interface that represents an evaluation unit, which is defined on process definitions and is evaluated at run-time in the context of process instance.
  IWFFieldSetter | Represents object field setter configured on a workflow action.
  IWFIfElseEval | Interface that represents if-else evaluation in the context of process instance.
  IWFListEval | Interface that represents list of evaluation units, which results in the list of values when evaluated.
  IWFObjectCountEval | Interface that represents object count evaluation unit.
  IWFObjectFieldEval | Interface that represents object field(s) evaluation unit.
  IWFObjectsEval | Interface that represents object(s) evaluation unit.
  IWFProcess | Interface that represents the process instance.
  IWFProcessContext | Interface that represents the context of process instance.
  IWFProcessDefinition | Represents workflow process definition.
  IWFProcessDefinitionFindOptions | Represents options for `IWorkflowService.getProcessDefinitions(IWFProcessDefinitionFindOptions)`.
  IWFProcessEvent | Represents an event in a workflow process instance.
  IWFRangeEval |
  IWFRelationalConditionEval | Interface that represents single criterion to evaluate in the context of process instance
  IWFResultCount | Base interface to provide workflow object fetching result.
  IWFResultDateCount | Interface to provide workflow object fetching result by date grouping.
  IWFSearchCondition | Represents conditions for `IWFBaseFindOptions.addCondition(IWFSearchCondition)`.
  IWFSearchInCondition | Represents conditions for `IWFBaseFindOptions#addCondition(IWFSearchInCondition)`.
  IWFSearchRangeCondition | Represents conditions for `IWFBaseFindOptions#addCondition(IWFSearchRangeCondition)`.
  IWFSearchSimpleCondition | Represents conditions for `IWFBaseFindOptions#addCondition(IWFSearchSimpleCondition)`.
  IWFStringEval | Interface that represents string while executing enclosing evaluation unit in the context of process instance.
  IWFSwitchesEval | Interface that represents switch evaluation in the context of process instance.
  IWFSwitchesEval.IWFSwitchCase | Interface that represents one case of the switch evaluation
  IWFTransition | Interface that represents the workflow transition, which is operated by a user on the task view.
  IWFTransitionComment |
  IWFTransitionOptions |
  IWorkflowFactory | Represents the factory for the workflow object to be persisted on the system

- Class Summary
  Class | Description
  --- | ---
  BulkWorkflowActionOptions | Represents the options to start workflow actions in bulk, used by `IWorkflowService.startBulkWorkflowAction(BulkWorkflowActionOptions)`
  StartProcessesOptions | Represents the options to start workflows in bulk, used by `IWorkflowService.startProcessesInBulk(StartProcessesOptions)`
  WFActivityInstanceList | The list class to provide fetching result of activity instances Refer `IWorkflowService.getActivityInstances(IWFActivityInstanceFindOptions)`
  WFActivityNotificationList | The list class to provide fetching result of activity instance notifications Refer `IWorkflowService.getActivityNotifications(IWFActivityNotificationFindOptions)`
  WFConditionReport | Represents evaluation report of all the Validations defined on process definition during process transition.
  WFEvalResult | Represents evaluation result of a simple validation (i.e.
  WFProcessDefinitionList | The list class to provide fetching result of process definitions Refer `IWorkflowService.getProcessDefinitions(IWFProcessDefinitionFindOptions)`

- Enum Summary
  Enum | Description
  --- | ---
  IWFActivityInstanceFindOptions.DateScope | Enum used for setting the scope of due date grouping.
  WFAccessType | Represents the type of the access control for GRC object and transitions.
  WFAccessType.WFAccess | Represents types of access
  WFAccessType.WFRole | Represents types of roles
  WFActionType | Represents the type of the workflow actions
  WFActivityInstanceState | Represents the state of the activity instances
  WFActivityType | Represents the type of the activity.
  WFConditionAttribute | Represents the type of the workflow Condition attributes
  WFDateAlterOperation | Enumeration that represents operations to alter dates.
  WFEvalType | Enumeration that represents evaluation unit type Refer `IWFEvalUnit` for more detail
  WFObjectReferenceType | Enumeration that represents types of object reference used by `IWFObjectFieldEval`.
  WFProcessCriticality | Represents criticality of the workflow/process instance
  WFProcessDefinitionState | Represents the state of process definition.
  WFProcessDefinitionType | Represents the type of process definition.
  WFProcessEventType | Represents the type of process event being logged for workflow operations.
  WFProcessState | Represents the state of workflow/process instances Refer `IWFProcess`
  WFProcessType | Represents types of process
  WFRelationalOperatorType | Enumeration that represents the type of relational operator used by `IWFRelationalConditionEval`
  WFSearchConditionType | Represents the type of the condition used to fetch the workflow objects.
  WFTransitionCommentRequirementType | Represents whether a comment is required, optional, or not when transitioning a workflow.

- Exception Summary
  Exception | Description
  --- | ---
  WFException | Represents exception thrown by the native workflow system.

## Package com.ibm.openpages.api.workflow Description

Provides interfaces to work with native workflow system. Refer `IWorkflowService`

Since:
  8.0.0.2

Licensed Materials - Property of IBM
OpenPages with Watson (PID: 5725-D51)
© Copyright IBM Corporation 2013, 2021. All Rights Reserved.
US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.