Skip to content

VSN-2035 : Adding necessary circuit data in the preparation database.

yassine.elazami a demandé de fusionner VSN-2035 vers develop

Merge Request Description

Title

Prepared Amendments & Transport Schedule Modeling – Circuit, Passenger, Representative and Scheduling Enhancements

Overview

This merge request introduces a comprehensive data model for prepared amendments related to circuits, passengers, representatives, and transport schedules.
The objective is to structure amendment-related entities in a clear, reusable, and domain-aligned way, while removing redundant or non-managed classes and improving overall consistency.

The changes lay the foundation for future amendment workflows by clearly separating prepared data, amendment documents, and scheduling structures, ensuring better maintainability and extensibility.

Key Changes and Enhancements

1. Prepared and Amendment Domain Modeling

  • Introduced a Prepared Circuit document to represent circuit data in a prepared (pre-validation / pre-commit) state.
  • Added a Prepared Amendment base class to serve as a common parent for amendment-related documents.
  • Defined an Amendment Circuit document, enabling structured amendment tracking at the circuit level.
  • Added a Prepared Amendment Passenger document, allowing passenger-level changes to be handled independently and cleanly.
  • Introduced an Amendment Representative document, enabling amendment tracking for passenger representatives.

These changes establish a clear and extensible hierarchy for handling amendments across different transport and passenger entities.

2. Passenger Scheduling Enhancements

  • Added a Passenger Schedule Week document, formalizing weekly scheduling information for passengers.
  • Introduced a Transport Schedule Amendment document, enabling future changes to transport schedules to be versioned and tracked independently.
  • Improved references between amendment schedules and existing prepared entities to avoid duplication and ambiguity.

This provides a scalable structure for managing both current schedules and amended schedules over time.

3. Refactoring and Cleanup

  • Removed the redundant Prepared Amendment class that was not managed as a Spring bean and caused conceptual overlap.
  • Refactored AmendmentPassengerSchedule references to rely on existing amendment classes instead of newly instantiated duplicates.
  • Consolidated amendment-related classes under the appropriate circuit and amendment packages to improve coherence.
  • Ensured that all amendment documents follow consistent naming, inheritance, and referencing rules.

These refactorings reduce technical debt and prevent future inconsistencies.

4. Documentation

  • Updated the changelog to reflect the introduction of amendment documents, scheduling enhancements, and structural refactors.
  • Ensured changes are clearly traceable for future maintenance and onboarding.

Impact and Benefits

  • Provides a solid and extensible foundation for amendment workflows.
  • Improves domain clarity between prepared data, amendments, and schedules.
  • Eliminates redundant or unmanaged classes.
  • Enhances maintainability, readability, and long-term scalability of the transport and passenger modules.

Notes

  • No breaking changes introduced at the API level.
  • Changes are focused on domain modeling and internal structure.
  • Future features such as amendment validation, approval flows, or history tracking can be built directly on top of this model.

Closes VSN-2035

Modification effectuée par yassine.elazami

Rapports de requête de fusion