ec status check event

Author: Jens Kürten

csfunctions/events/__init__.py

@@ -11,6 +11,10 @@
 from .dummy import DummyEvent, DummyEventData
 from .engineering_change_release import EngineeringChangeRelease, EngineeringChangeReleaseData
 from .engineering_change_release_check import EngineeringChangeReleaseCheck, EngineeringChangeReleaseCheckData
+from .engineering_change_status_change_check import (
+    EngineeringChangeStatusChangeCheck,
+    EngineeringChangeStatusChangeCheckData,
+)
 from .engineering_change_status_changed import EngineeringChangeStatusChanged, EngineeringChangeStatusChangedData
 from .field_value_calculation import FieldValueCalculationData, FieldValueCalculationEvent
 from .part_create_check import PartCreateCheckData, PartCreateCheckEvent
@@ -33,6 +37,7 @@
         EngineeringChangeRelease,
         EngineeringChangeReleaseCheck,
         EngineeringChangeStatusChanged,
+        EngineeringChangeStatusChangeCheck,
         WorkflowTaskTriggerEvent,
         DocumentCreateCheckEvent,
         DocumentModifyCheckEvent,
@@ -53,6 +58,7 @@
     EngineeringChangeReleaseData,
     EngineeringChangeReleaseCheckData,
     EngineeringChangeStatusChangedData,
+    EngineeringChangeStatusChangeCheckData,
     WorkflowTaskTriggerEventData,
     DocumentCreateCheckData,
     DocumentModifyCheckData,
@@ -72,6 +78,7 @@
     "EngineeringChangeRelease",
     "EngineeringChangeReleaseCheck",
     "EngineeringChangeStatusChanged",
+    "EngineeringChangeStatusChangeCheck",
     "WorkflowTaskTriggerEvent",
     "DocumentReleaseData",
     "DocumentReleaseCheckData",
@@ -83,6 +90,7 @@
     "EngineeringChangeReleaseData",
     "EngineeringChangeReleaseCheckData",
     "EngineeringChangeStatusChangedData",
+    "EngineeringChangeStatusChangeCheckData",
     "WorkflowTaskTriggerEventData",
     "DocumentReleaseDialogData",
     "PartReleaseDialogData",

csfunctions/events/base.py

@@ -20,6 +20,7 @@ class EventNames(str, Enum):
     PART_CREATE_CHECK = "part_create_check"
     PART_MODIFY_CHECK = "part_modify_check"
     ENGINEERING_CHANGE_STATUS_CHANGED = "engineering_change_status_changed"
+    ENGINEERING_CHANGE_STATUS_CHANGE_CHECK = "engineering_change_status_change_check"
 
 
 class BaseEvent(BaseModel):

csfunctions/events/engineering_change_status_change_check.py

@@ -0,0 +1,21 @@
+from typing import Literal
+
+from pydantic import BaseModel, Field
+
+from csfunctions.objects import Document, EngineeringChange, Part
+
+from .base import BaseEvent, EventNames
+
+
+class EngineeringChangeStatusChangeCheckData(BaseModel):
+    engineering_change: EngineeringChange = Field(
+        ..., description="The engineering change that will have its status modified"
+    )
+    target_status: int = Field(..., description="The target status of the engineering change")
+    documents: list[Document] = Field(..., description="List of documents attached to the engineering change")
+    parts: list[Part] = Field(..., description="List of parts attached to the engineering change")
+
+
+class EngineeringChangeStatusChangeCheck(BaseEvent):
+    name: Literal[EventNames.ENGINEERING_CHANGE_STATUS_CHANGE_CHECK] = EventNames.ENGINEERING_CHANGE_STATUS_CHANGE_CHECK
+    data: EngineeringChangeStatusChangeCheckData

docs/reference/events.md

@@ -285,3 +285,23 @@ This event is fired **after** an engineering change's status has been modified.
 |prev_status|str|The previous status of the engineering change|
 |documents|list[[Document](objects.md#document)]|List of documents attached to the engineering change|
 |parts|list[[Part](objects.md#part)]|List of parts attached to the engineering change|
+
+## EngineeringChangeStatusChangeCheck
+`csfunctions.events.EngineeringChangeStatusChangeCheck`
+
+This event is fired when a user tries to modify an engineering change's status. Raising an exception will prevent the status change.
+
+**Supported actions:**
+
+- [AbortAndShowErrorAction](actions.md#AbortAndShowErrorAction)
+
+**EngineeringChangeStatusChangeCheck.name:** engineering_change_status_change_check
+
+**EngineeringChangeStatusChangeCheck.data:**
+
+|Attribute|Type|Description|
+|-|-|-|
+|engineering_change|[EngineeringChange](objects.md#engineeringchange)|The engineering change that will have its status modified|
+|target_status|int|The status the engineering change will be set to|
+|documents|list[[Document](objects.md#document)]|List of documents attached to the engineering change|
+|parts|list[[Part](objects.md#part)]|List of parts attached to the engineering change|