ast_workflow.go

// SPDX-License-Identifier: Apache-2.0

package ast

// CreateWorkflowStmt represents: CREATE WORKFLOW Module.Name ...
type CreateWorkflowStmt struct {
	Name           QualifiedName
	CreateOrModify bool
	Documentation  string

	// Context parameter entity
	ParameterVar    string        // e.g. "$WorkflowContext"
	ParameterEntity QualifiedName // e.g. Module.Entity

	// Display metadata
	DisplayName string // from DISPLAY 'text'
	Description string // from DESCRIPTION 'text'
	ExportLevel string // "Hidden" or "API", from EXPORT LEVEL identifier

	// Optional metadata
	OverviewPage QualifiedName // qualified name of overview page
	DueDate      string        // due date expression

	// Activities
	Activities []WorkflowActivityNode
}

func (s *CreateWorkflowStmt) isStatement() {}

// DropWorkflowStmt represents: DROP WORKFLOW Module.Name
type DropWorkflowStmt struct {
	Name QualifiedName
}

func (s *DropWorkflowStmt) isStatement() {}

// WorkflowActivityNode is the interface for workflow activity AST nodes.
type WorkflowActivityNode interface {
	workflowActivityNode()
}

// WorkflowUserTaskNode represents a USER TASK activity.
type WorkflowUserTaskNode struct {
	Name            string // identifier name
	Caption         string // display caption
	Page            QualifiedName
	Targeting       WorkflowTargetingNode
	Entity          QualifiedName // user task entity
	DueDate         string        // DUE DATE expression
	Outcomes        []WorkflowUserTaskOutcomeNode
	IsMultiUser     bool                        // Issue #8: true if MULTI USER TASK
	BoundaryEvents  []WorkflowBoundaryEventNode // Issue #7
	TaskDescription string                      // from DESCRIPTION 'text'
}

func (n *WorkflowUserTaskNode) workflowActivityNode() {}

// WorkflowTargetingNode represents user targeting strategy.
// Kind: "microflow", "xpath", "group_microflow", "group_xpath", or ""
type WorkflowTargetingNode struct {
	Kind      string        // "microflow", "xpath", "group_microflow", "group_xpath", or ""
	Microflow QualifiedName // for microflow targeting (user or group)
	XPath     string        // for xpath targeting (user or group)
}

// WorkflowUserTaskOutcomeNode represents an outcome of a user task.
type WorkflowUserTaskOutcomeNode struct {
	Caption    string
	Activities []WorkflowActivityNode
}

// WorkflowCallMicroflowNode represents a CALL MICROFLOW activity.
type WorkflowCallMicroflowNode struct {
	Microflow         QualifiedName
	Caption           string
	Outcomes          []WorkflowConditionOutcomeNode
	ParameterMappings []WorkflowParameterMappingNode // Issue #10
	BoundaryEvents    []WorkflowBoundaryEventNode    // Issue #7
}

func (n *WorkflowCallMicroflowNode) workflowActivityNode() {}

// WorkflowCallWorkflowNode represents a CALL WORKFLOW activity.
type WorkflowCallWorkflowNode struct {
	Workflow          QualifiedName
	Caption           string
	ParameterMappings []WorkflowParameterMappingNode
}

func (n *WorkflowCallWorkflowNode) workflowActivityNode() {}

// WorkflowDecisionNode represents a DECISION activity.
type WorkflowDecisionNode struct {
	Expression string // decision expression
	Caption    string
	Outcomes   []WorkflowConditionOutcomeNode
}

func (n *WorkflowDecisionNode) workflowActivityNode() {}

// WorkflowConditionOutcomeNode represents an outcome of a decision or call microflow.
type WorkflowConditionOutcomeNode struct {
	Value      string // "True", "False", "Default", or enumeration value
	Activities []WorkflowActivityNode
}

// WorkflowParallelSplitNode represents a PARALLEL SPLIT activity.
type WorkflowParallelSplitNode struct {
	Caption string
	Paths   []WorkflowParallelPathNode
}

func (n *WorkflowParallelSplitNode) workflowActivityNode() {}

// WorkflowParallelPathNode represents a path in a parallel split.
type WorkflowParallelPathNode struct {
	PathNumber int
	Activities []WorkflowActivityNode
}

// WorkflowJumpToNode represents a JUMP TO activity.
type WorkflowJumpToNode struct {
	Target  string // name of target activity
	Caption string
}

func (n *WorkflowJumpToNode) workflowActivityNode() {}

// WorkflowWaitForTimerNode represents a WAIT FOR TIMER activity.
type WorkflowWaitForTimerNode struct {
	DelayExpression string
	Caption         string
}

func (n *WorkflowWaitForTimerNode) workflowActivityNode() {}

// WorkflowWaitForNotificationNode represents a WAIT FOR NOTIFICATION activity.
type WorkflowWaitForNotificationNode struct {
	Caption        string
	BoundaryEvents []WorkflowBoundaryEventNode // Issue #7
}

func (n *WorkflowWaitForNotificationNode) workflowActivityNode() {}

// WorkflowEndNode represents an END activity.
type WorkflowEndNode struct {
	Caption string
}

func (n *WorkflowEndNode) workflowActivityNode() {}

// WorkflowBoundaryEventNode represents a BOUNDARY EVENT clause on a user task.
// Issue #7
type WorkflowBoundaryEventNode struct {
	EventType  string                 // "InterruptingTimer", "NonInterruptingTimer", "Timer"
	Delay      string                 // ISO duration expression e.g. "${PT1H}"
	Activities []WorkflowActivityNode // Sub-flow activities inside the boundary event
}

// WorkflowAnnotationActivityNode represents an ANNOTATION activity in a workflow.
// Issue #9
type WorkflowAnnotationActivityNode struct {
	Text string
}

func (n *WorkflowAnnotationActivityNode) workflowActivityNode() {}

// WorkflowParameterMappingNode represents a parameter mapping in a CALL MICROFLOW WITH clause.
// Issue #10
type WorkflowParameterMappingNode struct {
	Parameter  string // parameter name (by-name reference)
	Expression string // Mendix expression string
}

// AlterWorkflowStmt represents: ALTER WORKFLOW Module.Name operations...
type AlterWorkflowStmt struct {
	Name       QualifiedName
	Operations []AlterWorkflowOp
}

func (s *AlterWorkflowStmt) isStatement() {}

// AlterWorkflowOp is the interface for ALTER WORKFLOW operations.
type AlterWorkflowOp interface {
	alterWorkflowOp()
}

// SetWorkflowPropertyOp sets a workflow-level property.
type SetWorkflowPropertyOp struct {
	Property string        // "DISPLAY", "DESCRIPTION", "EXPORT_LEVEL", "DUE_DATE", "OVERVIEW_PAGE", "PARAMETER"
	Value    string        // string value
	Entity   QualifiedName // for OVERVIEW_PAGE / PARAMETER: the qualified name
}

func (o *SetWorkflowPropertyOp) alterWorkflowOp() {}

// SetActivityPropertyOp sets a property on a named activity.
type SetActivityPropertyOp struct {
	ActivityRef string        // activity caption
	AtPosition  int           // positional disambiguation (0 = no disambiguation)
	Property    string        // "PAGE", "DESCRIPTION", "TARGETING_MICROFLOW", "TARGETING_XPATH", "DUE_DATE"
	Value       string        // string value
	PageName    QualifiedName // for PAGE property
	Microflow   QualifiedName // for TARGETING MICROFLOW
}

func (o *SetActivityPropertyOp) alterWorkflowOp() {}

// InsertAfterOp inserts an activity after a named activity (linear position).
type InsertAfterOp struct {
	ActivityRef string
	AtPosition  int
	NewActivity WorkflowActivityNode
}

func (o *InsertAfterOp) alterWorkflowOp() {}

// DropActivityOp removes a linear activity from the flow graph.
type DropActivityOp struct {
	ActivityRef string
	AtPosition  int
}

func (o *DropActivityOp) alterWorkflowOp() {}

// ReplaceActivityOp swaps an activity in place, preserving edges.
type ReplaceActivityOp struct {
	ActivityRef string
	AtPosition  int
	NewActivity WorkflowActivityNode
}

func (o *ReplaceActivityOp) alterWorkflowOp() {}

// InsertOutcomeOp adds a new outcome to a UserTask.
type InsertOutcomeOp struct {
	OutcomeName string
	ActivityRef string
	AtPosition  int
	Activities  []WorkflowActivityNode
}

func (o *InsertOutcomeOp) alterWorkflowOp() {}

// DropOutcomeOp removes an outcome from a UserTask.
type DropOutcomeOp struct {
	OutcomeName string
	ActivityRef string
	AtPosition  int
}

func (o *DropOutcomeOp) alterWorkflowOp() {}

// InsertPathOp adds a new path to a ParallelSplit.
type InsertPathOp struct {
	ActivityRef string
	AtPosition  int
	Activities  []WorkflowActivityNode
}

func (o *InsertPathOp) alterWorkflowOp() {}

// DropPathOp removes a path from a ParallelSplit.
type DropPathOp struct {
	PathCaption string
	ActivityRef string
	AtPosition  int
}

func (o *DropPathOp) alterWorkflowOp() {}

// InsertBranchOp adds a new branch to a Decision.
type InsertBranchOp struct {
	Condition   string
	ActivityRef string
	AtPosition  int
	Activities  []WorkflowActivityNode
}

func (o *InsertBranchOp) alterWorkflowOp() {}

// DropBranchOp removes a branch from a Decision.
type DropBranchOp struct {
	BranchName  string
	ActivityRef string
	AtPosition  int
}

func (o *DropBranchOp) alterWorkflowOp() {}

// InsertBoundaryEventOp adds a boundary event to an activity.
type InsertBoundaryEventOp struct {
	ActivityRef string
	AtPosition  int
	EventType   string // "InterruptingTimer", "NonInterruptingTimer"
	Delay       string
	Activities  []WorkflowActivityNode
}

func (o *InsertBoundaryEventOp) alterWorkflowOp() {}

// DropBoundaryEventOp removes a boundary event from an activity.
type DropBoundaryEventOp struct {
	ActivityRef string
	AtPosition  int
}

func (o *DropBoundaryEventOp) alterWorkflowOp() {}