process

package
v0.1.61 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 1, 2025 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type API

type API interface {
	SearchProcessDefinitions(ctx context.Context, filter ProcessDefinitionSearchFilterOpts, size int32, opts ...options.FacadeOption) (ProcessDefinitions, error)
	GetProcessDefinitionsLatest(ctx context.Context) (ProcessDefinitions, error)
	GetProcessDefinitionByKey(ctx context.Context, key string, opts ...options.FacadeOption) (ProcessDefinition, error)
	GetProcessDefinitionsByBpmnProcessId(ctx context.Context, bpmnProcessId string, opts ...options.FacadeOption) (ProcessDefinitions, error)
	GetProcessDefinitionByBpmnProcessIdLatest(ctx context.Context, bpmnProcessId string, opts ...options.FacadeOption) (ProcessDefinition, error)
	GetProcessDefinitionByBpmnProcessIdAndVersion(ctx context.Context, bpmnProcessId string, version int32, opts ...options.FacadeOption) (ProcessDefinition, error)

	GetProcessInstanceByKey(ctx context.Context, key string, opts ...options.FacadeOption) (ProcessInstance, error)
	SearchProcessInstances(ctx context.Context, filter ProcessInstanceSearchFilterOpts, size int32, opts ...options.FacadeOption) (ProcessInstances, error)
	CancelProcessInstance(ctx context.Context, key string, opts ...options.FacadeOption) (CancelResponse, error)
	GetDirectChildrenOfProcessInstance(ctx context.Context, key string, opts ...options.FacadeOption) (ProcessInstances, error)
	FilterProcessInstanceWithOrphanParent(ctx context.Context, items []ProcessInstance, opts ...options.FacadeOption) ([]ProcessInstance, error)
	DeleteProcessInstance(ctx context.Context, key string, opts ...options.FacadeOption) (ChangeStatus, error)
	WaitForProcessInstanceState(ctx context.Context, key string, desired States, opts ...options.FacadeOption) (State, error)
	Walker
}

func New

func New(pdApi pdsvc.API, piApi pisvc.API) API

type CancelResponse

type CancelResponse struct {
	StatusCode int
	Status     string
}

type ChangeStatus

type ChangeStatus struct {
	Deleted int64
	Message string
}

func (ChangeStatus) String

func (c ChangeStatus) String() string

type ProcessDefinition

type ProcessDefinition struct {
	BpmnProcessId string `json:"bpmnProcessId,omitempty"`
	Key           string `json:"key,omitempty"`
	Name          string `json:"name,omitempty"`
	TenantId      string `json:"tenantId,omitempty"`
	Version       int32  `json:"version,omitempty"`
	VersionTag    string `json:"versionTag,omitempty"`
}

type ProcessDefinitionSearchFilterOpts

type ProcessDefinitionSearchFilterOpts struct {
	Key           string `json:"key,omitempty"`
	BpmnProcessId string `json:"bpmnProcessId,omitempty"`
	Version       int32  `json:"version,omitempty"`
	VersionTag    string `json:"versionTag,omitempty"`
}

type ProcessDefinitions

type ProcessDefinitions struct {
	Total int32               `json:"total,omitempty"`
	Items []ProcessDefinition `json:"items,omitempty"`
}

type ProcessInstance

type ProcessInstance struct {
	BpmnProcessId             string `json:"bpmnProcessId,omitempty"`
	EndDate                   string `json:"endDate,omitempty"`
	Incident                  bool   `json:"incident,omitempty"`
	Key                       string `json:"key,omitempty"`
	ParentFlowNodeInstanceKey string `json:"parentFlowNodeInstanceKey,omitempty"`
	ParentKey                 string `json:"parentKey,omitempty"`
	ParentProcessInstanceKey  string `json:"parentProcessInstanceKey,omitempty"`
	ProcessDefinitionKey      string `json:"processDefinitionKey,omitempty"`
	ProcessVersion            int32  `json:"processVersion,omitempty"`
	ProcessVersionTag         string `json:"processVersionTag,omitempty"`
	StartDate                 string `json:"startDate,omitempty"`
	State                     State  `json:"state,omitempty"`
	TenantId                  string `json:"tenantId,omitempty"`
}

type ProcessInstanceSearchFilterOpts

type ProcessInstanceSearchFilterOpts struct {
	Key               string
	BpmnProcessId     string
	ProcessVersion    int32
	ProcessVersionTag string
	State             State
	ParentKey         string
}

type ProcessInstances

type ProcessInstances struct {
	Total int32             `json:"total,omitempty"`
	Items []ProcessInstance `json:"items,omitempty"`
}

func (ProcessInstances) FilterByHavingIncidents

func (r ProcessInstances) FilterByHavingIncidents(has bool) ProcessInstances

func (ProcessInstances) FilterChildrenOnly

func (r ProcessInstances) FilterChildrenOnly() ProcessInstances

func (ProcessInstances) FilterParentsOnly

func (r ProcessInstances) FilterParentsOnly() ProcessInstances

type State

type State string
const (
	StateAll        State = "ALL"
	StateActive     State = "ACTIVE"
	StateCompleted  State = "COMPLETED"
	StateCanceled   State = "CANCELED"
	StateTerminated State = "TERMINATED"
)

func ParseState

func ParseState(in string) (State, bool)

func (State) EqualsIgnoreCase

func (s State) EqualsIgnoreCase(other State) bool

func (State) In

func (s State) In(states ...State) bool

func (State) IsTerminal

func (s State) IsTerminal() bool

func (State) String

func (s State) String() string

type States

type States []State

func ParseStates

func ParseStates(in []string) (States, error)

func (States) Contains

func (sx States) Contains(state State) bool

func (States) String

func (sx States) String() string

func (States) Strings

func (sx States) Strings() []string

type Walker

type Walker interface {
	Ancestry(ctx context.Context, startKey string, opts ...options.FacadeOption) (rootKey string, path []string, chain map[string]ProcessInstance, err error)
	Descendants(ctx context.Context, rootKey string, opts ...options.FacadeOption) (desc []string, edges map[string][]string, chain map[string]ProcessInstance, err error)
	Family(ctx context.Context, startKey string, opts ...options.FacadeOption) (fam []string, edges map[string][]string, chain map[string]ProcessInstance, err error)
}

func AsWalker

func AsWalker(client API) (Walker, bool)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL