[COMP-766-2] Added historical and linkable order creation methods (#713)

Ckoelewyn · web-flow · commit ba9089046af9 · 2026-02-05T15:09:19.000-08:00
diff --git a/compliance-api/src/compliance_api/models/administrative_penalty.py b/compliance-api/src/compliance_api/models/administrative_penalty.py
@@ -308,7 +308,7 @@ def get_by_administrative_penalty_number(cls, administrative_penalty_number):
         ).first()
 
     @classmethod
-    def get_count_by_project_nd_case_file_id(cls, project_id: int, case_file_id: int):
+    def get_count_by_project_and_case_file_id(cls, project_id: int, case_file_id: int):
         """Get count of administrative penalties by project and case file id."""
         result = (
             cls.query.join(InspectionModel, InspectionModel.id == cls.inspection_id)
diff --git a/compliance-api/src/compliance_api/models/charge_recommendation.py b/compliance-api/src/compliance_api/models/charge_recommendation.py
@@ -350,7 +350,7 @@ def get_by_charge_recommendation_number(
 
     @classmethod
     @with_session
-    def get_count_by_project_nd_case_file_id(
+    def get_count_by_project_and_case_file_id(
         cls, project_id: int, case_file_id: int, session=None
     ):
         """Get count of charge recommendations by project and case file id."""
diff --git a/compliance-api/src/compliance_api/models/complaint/complaint.py b/compliance-api/src/compliance_api/models/complaint/complaint.py
@@ -171,7 +171,7 @@ class Complaint(BaseModelVersioned):
     )
 
     @classmethod
-    def get_count_by_project_nd_case_file_id(cls, project_id: int, case_file_id: int):
+    def get_count_by_project_and_case_file_id(cls, project_id: int, case_file_id: int):
         """Return the number of complaint based on the project and case file id."""
         result = (
             cls.query.with_entities(
diff --git a/compliance-api/src/compliance_api/models/inspection/inspection.py b/compliance-api/src/compliance_api/models/inspection/inspection.py
@@ -151,7 +151,7 @@ class Inspection(BaseModelVersioned):
     )
 
     @classmethod
-    def get_count_by_project_nd_case_file_id(cls, project_id: int, case_file_id: int):
+    def get_count_by_project_and_case_file_id(cls, project_id: int, case_file_id: int):
         """Return the number of inspection based on the project and case file id."""
         result = (
             cls.query.join(CaseFileModel, Inspection.case_file_id == CaseFileModel.id)
diff --git a/compliance-api/src/compliance_api/models/order.py b/compliance-api/src/compliance_api/models/order.py
@@ -5,6 +5,7 @@
 from sqlalchemy import Boolean, Column, DateTime, Enum, ForeignKey, Index, Integer, String, func
 from sqlalchemy.orm import relationship
 
+from compliance_api.models.inspection import InspectionRequirement
 from compliance_api.utils.constant import DELETE_DIC_PARAMS
 from compliance_api.utils.util import get_sorted_numbers_from_generated_code
 
@@ -77,6 +78,29 @@ def get_by_requirement_id(cls, requirement_id):
             inspection_requirement_id=requirement_id, is_deleted=False, is_active=True
         ).first()
 
+    @classmethod
+    def get_by_inspection_and_order_id(
+        cls, inspection_id: int, order_id: int
+    ):
+        """Get inspection requirement maps by inspection id and order id."""
+        return (
+            cls.query.join(
+                InspectionRequirement,
+                InspectionRequirement.id == cls.inspection_requirement_id
+            )
+            .join(
+                InspectionModel,
+                InspectionModel.id == InspectionRequirement.inspection_id
+            )
+            .filter(
+                InspectionModel.id == inspection_id,
+                cls.order_id == order_id,
+                cls.is_deleted.is_(False),
+                cls.is_active.is_(True),
+            )
+            .all()
+        )
+
     @classmethod
     @with_session
     def bulk_delete(
@@ -226,7 +250,7 @@ def update_order(cls, order_id, order_data, session=None):
         return order
 
     @classmethod
-    def get_count_by_project_nd_case_file_id(cls, project_id: int, case_file_id: int):
+    def get_count_by_project_and_case_file_id(cls, project_id: int, case_file_id: int):
         """Get count of orders by project and case file id."""
         result = (
             cls.query.join(InspectionModel, InspectionModel.id == cls.inspection_id)
@@ -282,10 +306,28 @@ def get_orders_by_case_files(cls, case_file_ids: list[int]):
 
     @classmethod
     def get_by_inspection_id(cls, inspection_id):
-        """Find all orders by inspection id."""
-        return cls.query.filter_by(
-            inspection_id=inspection_id, is_deleted=False, is_active=True
-        ).all()
+        """Find all orders by inspection id that have entries in the requirement map for the given inspection."""
+        return (
+            cls.query.join(
+                OrderInspectionRequirementMap,
+                OrderInspectionRequirementMap.order_id
+                == cls.id,
+            )
+            .join(
+                InspectionRequirement,
+                InspectionRequirement.id
+                == OrderInspectionRequirementMap.inspection_requirement_id,
+            )
+            .filter(
+                InspectionRequirement.inspection_id == inspection_id,
+                OrderInspectionRequirementMap.is_active.is_(True),
+                OrderInspectionRequirementMap.is_deleted.is_(False),
+                cls.is_deleted.is_(False),
+            )
+            .distinct()
+            .order_by(cls.created_date.desc())
+            .all()
+        )
 
     @classmethod
     def has_replacement_order(cls, original_order_id: int):
diff --git a/compliance-api/src/compliance_api/models/restorative_justice.py b/compliance-api/src/compliance_api/models/restorative_justice.py
@@ -286,7 +286,7 @@ def get_by_restorative_justice_number(
 
     @classmethod
     @with_session
-    def get_count_by_project_nd_case_file_id(
+    def get_count_by_project_and_case_file_id(
         cls, project_id: int, case_file_id: int, session=None
     ):
         """Get count of restorative justices by project and case file id."""
diff --git a/compliance-api/src/compliance_api/models/warning_letter.py b/compliance-api/src/compliance_api/models/warning_letter.py
@@ -227,7 +227,7 @@ def get_by_warning_letter_number(cls, warning_letter_number):
         ).first()
 
     @classmethod
-    def get_count_by_project_nd_case_file_id(cls, project_id: int, case_file_id: int):
+    def get_count_by_project_and_case_file_id(cls, project_id: int, case_file_id: int):
         """Get count of warning letters by project and case file id."""
         result = (
             cls.query.join(InspectionModel, InspectionModel.id == cls.inspection_id)
diff --git a/compliance-api/src/compliance_api/resources/order.py b/compliance-api/src/compliance_api/resources/order.py
@@ -12,9 +12,9 @@
 from compliance_api.services.order.order_approval import OrderApprovalService
 
 from ..schemas import (
-    CreateOrderApprovalSchema, OrderApprovalSchema, OrderCreateSchema, OrderIssueSchema, OrderReplaceSchema,
-    OrderSchema, OrderStatusSchema, OrderUpdateSchema, RenderRequestSchema, ResetOrderFieldSchema,
-    UpdateOrderApprovalStatusSchema)
+    CreateOrderApprovalSchema, OrderApprovalSchema, OrderCreateSchema, OrderIssueSchema, OrderLinkCreateSchema,
+    OrderLinksResponseSchema, OrderReplaceSchema, OrderSchema, OrderStatusSchema, OrderUpdateSchema,
+    RenderRequestSchema, ResetOrderFieldSchema, UpdateOrderApprovalStatusSchema)
 from ..utils.util import cors_preflight
 from .apihelper import Api as ApiHelper
 
@@ -58,6 +58,14 @@
     API, OrderReplaceSchema(), "OrderReplace"
 )
 
+order_links_create_model = ApiHelper.convert_ma_schema_to_restx_model(
+    API, OrderLinkCreateSchema(), "OrderLinkCreate"
+)
+
+order_links_response_model = ApiHelper.convert_ma_schema_to_restx_model(
+    API, OrderLinksResponseSchema(), "OrderLinksResponse"
+)
+
 
 @cors_preflight("GET, OPTIONS, POST")
 @API.route("", methods=["POST", "GET", "OPTIONS"])
@@ -355,3 +363,36 @@ def patch(order_id, approval_id):
             order_id, approval_id, approval_update_data
         )
         return OrderApprovalSchema().dump(updated_approval), HTTPStatus.OK
+
+
+@cors_preflight("POST, OPTIONS")
+@API.route("/links", methods=["POST", "OPTIONS"])
+class OrderLinks(Resource):
+    """Link inspection orders."""
+
+    @staticmethod
+    @auth.require
+    @API.expect(order_links_create_model)
+    @API.response(400, "Bad Request")
+    @API.response(404, "Not Found")
+    @API.response(
+        code=201,
+        model=order_list_model,
+        description="Success",
+    )
+    @ApiHelper.swagger_decorators(
+        API,
+        endpoint_description="Link inspection orders",
+    )
+    def post():
+        """Link this Order to inspection requirements."""
+        link = OrderLinkCreateSchema().load(API.payload)
+        order_id = link.get("order_id")
+        created_link = OrderService.link(
+            order_id,
+            link
+        )
+        return (
+            OrderLinksResponseSchema().dump(created_link),
+            HTTPStatus.CREATED,
+        )
diff --git a/compliance-api/src/compliance_api/schemas/__init__.py b/compliance-api/src/compliance_api/schemas/__init__.py
@@ -49,8 +49,8 @@
 from .inspection_requirement_grid import InspectionRequirementFilterSchema, InspectionRequirementGridItemSchema
 from .ir_download_request import CreateIRDownloadRequestSchema, IRDownloadRequestQuerySchema, IRDownloadRequestSchema
 from .order import (
-    OrderCreateSchema, OrderIssueSchema, OrderReplaceSchema, OrderSchema, OrderStatusSchema, OrderUpdateSchema,
-    ResetOrderFieldSchema)
+    OrderCreateSchema, OrderIssueSchema, OrderLinkCreateSchema, OrderLinksResponseSchema, OrderReplaceSchema,
+    OrderSchema, OrderStatusSchema, OrderUpdateSchema, ResetOrderFieldSchema)
 from .order_approval import CreateOrderApprovalSchema, OrderApprovalSchema, UpdateOrderApprovalStatusSchema
 from .paginate import PaginationParameterSchema
 from .project import ProjectSchema
diff --git a/compliance-api/src/compliance_api/schemas/inspection_requirement.py b/compliance-api/src/compliance_api/schemas/inspection_requirement.py
@@ -132,7 +132,7 @@ class InspectionReqDetailDocImageUpdateSchema(InspectionReqDetailDocImageCreateS
 
 
 class InspectionReqDetailDocCreateSchema(BaseSchema):
-    """InpsectionReqDetailDocCreateSchema."""
+    """InspectionReqDetailDocCreateSchema."""
 
     document_type_id = fields.Int(
         metadata={"description": "The unique identifier of the document type"},
diff --git a/compliance-api/src/compliance_api/schemas/order.py b/compliance-api/src/compliance_api/schemas/order.py
@@ -202,3 +202,46 @@ class OrderReplaceSchema(BaseSchema):
             "If not provided, a new number will be generated."
         },
     )
+
+
+class OrderLinkCreateSchema(BaseSchema):
+    """Schema for linking orders to inspection requirements."""
+
+    class Meta:  # pylint: disable=too-few-public-methods
+        """Exclude unknown fields in the deserialized output."""
+
+        unknown = EXCLUDE
+
+    order_id = fields.Integer(
+        required=True, metadata={"description": "The order id"}
+    )
+    inspection_id = fields.Integer(
+        required=True, metadata={"description": "The inspection id"}
+    )
+    inspection_requirement_ids = fields.List(
+        fields.Integer(),
+        required=True,
+        metadata={
+            "description": "List of inspection requirement IDs to link with the order."
+        },
+    )
+
+
+class OrderLinksResponseSchema(BaseSchema):
+    """Schema for linking orders to inspection requirements."""
+
+    class Meta:  # pylint: disable=too-few-public-methods
+        """Exclude unknown fields in the deserialized output."""
+
+        unknown = EXCLUDE
+
+    type = fields.String(
+        dump_default="OrderLink",
+        metadata={"description": "The type of this object"}
+    )
+    order_id = fields.Integer(
+        required=True, metadata={"description": "The order id"}
+    )
+    inspection_requirement_id = fields.Integer(
+        required=True, metadata={"description": "The inspection requirement id"}
+    )
diff --git a/compliance-api/src/compliance_api/services/inspection.py b/compliance-api/src/compliance_api/services/inspection.py
@@ -115,7 +115,6 @@ def get_inspection_details(cls, case_file_id):
         for inspection in inspections:
             data = inspection_data.get(inspection.id, {"requirement_details": []})
             setattr(inspection, "requirement_details", data["requirement_details"])
-
         return inspections
 
     @classmethod
diff --git a/compliance-api/src/compliance_api/services/order/order.py b/compliance-api/src/compliance_api/services/order/order.py
@@ -33,9 +33,7 @@ def get_all(cls, inspection_id: int = None) -> List[OrderModel]:
         """Get all orders for an inspection."""
         if inspection_id is None:
             return OrderModel.get_all()
-        return OrderModel.get_by_params(
-            {"inspection_id": inspection_id}, default_filters=False
-        )
+        return OrderModel.get_by_inspection_id(inspection_id)
 
     @classmethod
     def get_projectwise_orders(cls, case_file_id: int) -> List[OrderModel]:
@@ -101,6 +99,11 @@ def get_order_by_order_number(cls, order_number: str) -> OrderModel:
         """Retrieve an order by order number."""
         return OrderModel.get_by_order_number(order_number)
 
+    @classmethod
+    def get_by_inspection_id(cls, inspection_id: int) -> List[OrderModel]:
+        """Retrieve orders by inspection ID."""
+        return OrderInspectionRequirementMapModel.get_by_inspection_id(inspection_id)
+
     @classmethod
     def update_order(cls, order_id: int, update_data: dict) -> OrderModel:
         """Update an existing order."""
@@ -243,6 +246,57 @@ def issue_order(cls, order_id, issue):
             )
         return order
 
+    @classmethod
+    def link(cls, order_id: int, link: dict) -> OrderModel:
+        """Link an existing order to inspection requirements.
+
+        Args:
+            order_id: The order ID
+            link: Dict containing inspection_requirement_ids to be linked
+
+        Returns:
+            OrderModel: The order model after linking the requirements
+        """
+        # get the order
+        order = OrderModel.find_by_id(order_id)
+        if not order:
+            raise ResourceNotFoundError(f"Order with ID {order_id} not found")
+
+        # Also get the inspection to which we are linking, check user has access, check status
+        inspection_id = link.get("inspection_id")
+        inspection = ServiceUtils.inspection_exist_check(inspection_id=inspection_id)
+        ServiceUtils.access_check_update_for_inspection(inspection)
+        ServiceUtils.inspection_status_check(inspection)
+
+        # Check that both the order and inspection belong to the same project
+        order_project_id = order.inspection.case_file.project_id
+        inspection_project_id = inspection.case_file.project_id
+
+        if order_project_id != inspection_project_id:
+            raise UnprocessableEntityError(
+                "Order and Inspection must belong to the same project to be linked"
+            )
+
+        # validate the inspection requirements
+        requirement_ids = link.get("inspection_requirement_ids", [])
+        ServiceUtils.check_requirement_for_enforcement_action(
+            requirement_ids, EnforcementActionOptionEnum.ORDER.value
+        )
+        existing_requirements = (
+            OrderInspectionRequirementMapModel.get_by_inspection_and_order_id(
+                inspection_id, order_id
+            )
+        )
+        if existing_requirements:
+            raise UnprocessableEntityError(
+                "Order is already linked to the given inspection requirements"
+            )
+        with session_scope() as session:
+            cls.insert_or_update_inspection_requirements(
+                order_id, requirement_ids, session
+            )
+        return order
+
     @classmethod
     def render(cls, order_id, output_format):
         """Preview order."""
diff --git a/compliance-api/tests/integration/api/test_order.py b/compliance-api/tests/integration/api/test_order.py
@@ -13,7 +13,9 @@
 API_BASE_URL = "/api/orders/"
 
 
-def test_get_orders(client, auth_header_super_user, created_inspection, created_order):
+def test_get_orders(
+    client, auth_header_super_user, created_inspection, created_order, created_order_requirement_map
+):
     """Test getting all orders for an inspection."""
     print(created_order.id)
     url = f"{API_BASE_URL}?inspection_id={created_inspection.id}"
diff --git a/compliance-web/src/components/App/Inspections/Profile/Enforcements/EnforcementUtils.ts b/compliance-web/src/components/App/Inspections/Profile/Enforcements/EnforcementUtils.ts
@@ -36,6 +36,9 @@ export const orderSchema = baseEnforcementSchema.shape({
       then: (schema) => schema.required("Manual Order # is required"),
       otherwise: (schema) => schema.notRequired(),
     }),
+  linkedOrderNumber: yup
+    .string()
+    .nullable(),
 });
 
 export type OrderFormType = yup.InferType<typeof orderSchema>;
@@ -44,6 +47,7 @@ export const initOrderFormData: OrderFormType = {
   requirements: [],
   isHistoricalRecord: false,
   manualOrderNumber: undefined,
+  linkedOrderNumber: undefined,
 };
 
 // Enforcement type detection functions
@@ -89,7 +93,7 @@ export const prepNonProceededRequirements = (
         (enforcement) => enforcement.id === enforcementActionType
       )
   );
-  
+
   return nonProceededRequirements.map(requirement => ({
     ...requirement,
     enforcement_action_data: requirement.enforcement_action_data?.filter(
diff --git a/compliance-web/src/components/App/Inspections/Profile/Enforcements/Orders/OrderCreateModal.tsx b/compliance-web/src/components/App/Inspections/Profile/Enforcements/Orders/OrderCreateModal.tsx
diff --git a/compliance-web/src/components/App/Inspections/Profile/Enforcements/Orders/OrderCreationOptions.tsx b/compliance-web/src/components/App/Inspections/Profile/Enforcements/Orders/OrderCreationOptions.tsx
diff --git a/compliance-web/src/components/App/Inspections/Profile/Enforcements/Orders/OrderDrawer.tsx b/compliance-web/src/components/App/Inspections/Profile/Enforcements/Orders/OrderDrawer.tsx
diff --git a/compliance-web/src/components/App/Inspections/Profile/InspectionEnforcements.tsx b/compliance-web/src/components/App/Inspections/Profile/InspectionEnforcements.tsx
diff --git a/compliance-web/src/hooks/useInspectionOrders.tsx b/compliance-web/src/hooks/useInspectionOrders.tsx
diff --git a/compliance-web/src/models/InspectionOrder.ts b/compliance-web/src/models/InspectionOrder.ts

Original file line number	Diff line number	Diff line change
`@@ -171,7 +171,7 @@ class Complaint(BaseModelVersioned):`
`171`	`171`	`)`
`172`	`172`
`173`	`173`	`@classmethod`
`174`		`- def get_count_by_project_nd_case_file_id(cls, project_id: int, case_file_id: int):`
	`174`	`+ def get_count_by_project_and_case_file_id(cls, project_id: int, case_file_id: int):`
`175`	`175`	`"""Return the number of complaint based on the project and case file id."""`
`176`	`176`	`result = (`
`177`	`177`	`cls.query.with_entities(`
Original file line number	Diff line number	Diff line change
`@@ -151,7 +151,7 @@ class Inspection(BaseModelVersioned):`
`151`	`151`	`)`
`152`	`152`
`153`	`153`	`@classmethod`
`154`		`- def get_count_by_project_nd_case_file_id(cls, project_id: int, case_file_id: int):`
	`154`	`+ def get_count_by_project_and_case_file_id(cls, project_id: int, case_file_id: int):`
`155`	`155`	`"""Return the number of inspection based on the project and case file id."""`
`156`	`156`	`result = (`
`157`	`157`	`cls.query.join(CaseFileModel, Inspection.case_file_id == CaseFileModel.id)`