Changes

=== Finishing a task ===

When a task is finished, the task logic calls CloseReservations().

The method processes active reservations for the task:

* if a reservation has status Confirmed, it is set to Issued

* otherwise, it is set to Cancelled

The changed reservations are added to the unsaved children through AddToUnsavedChildren(reservation) so that the changes are persisted.

'''Workflow effect:''' Finishing a task closes its reservations. Confirmed reservations become Issued; other active reservations become Cancelled.

</div>

== Usage in tasks ==

Reservations are the central link between material handling and task execution.

A reservation connects:

* the required material through LK_MATERIAL

* the task through LK_TASK

* the planned quantity through QTY_PLANNED

* the reservation state through Status

This means that material usage is tracked at task level in the inspected implementation.

'''Open point:''' The inspected information explicitly confirms the relation to tasks. Direct relations to work packages or work orders were not confirmed in the provided code analysis. If work packages or work orders use materials indirectly through tasks, that should be documented with the exact relation or navigation path.

</div>

== Goods movement usage ==

GoodsMovement is the common base class for quantity-bearing material objects.

Both Material and Reservation inherit from it and expose QUANTITY.

In the inspected implementation:

* Material.QUANTITY represents the material quantity

* Reservation.QUANTITY represents the actual quantity for the reservation and applies reservation-specific validation

* Reservation.QTY_PLANNED represents the planned reserved quantity

* Material.RESERVED_QUANTITY is calculated from confirmed reservations

'''Open point:''' The inspected information describes GoodsMovement as a base class for quantity-bearing objects. It does not confirm separate movement types such as goods receipt, goods issue, transfer, correction, or consumption postings.

</div>

== Example workflow ==

=== Scenario ===

A task requires one spare part from stock.

=== Step 1: Material master exists ===

The spare part is defined as a MaterialMaster.

{| class="wikitable"

! Field

! Example

|-

| ITEM_NUMBER

| OF-10045

|-

| UNIT_OF_MEASURE

| Piece

|-

| MaterialType

| SpareParts

|}

=== Step 2: Material exists in a storage location ===

A Material object references the material master and a storage location.

{| class="wikitable"

! Property

! Example

|-

| LK_MATERIAL_MASTER

| Oil Filter Type A

|-

| LK_STORAGE_LOCATION

| Storage Shelf A

|-

| QUANTITY

| 10

|-

| RESERVED_QUANTITY

| 0

|-

| AvailableQuantity()

| 10

|}

=== Step 3: Reservation is created for a task ===

A Reservation links the material to the task.

{| class="wikitable"

! Property

! Example

|-

| LK_TASK

| Replace oil filter

|-

| LK_MATERIAL

| Oil Filter Type A

|-

| Status

| Planned

|-

| QTY_PLANNED

| 1

|}

The planned quantity is allowed because the material has enough available quantity.

=== Step 4: Reservation is confirmed ===

The reservation status is changed to Confirmed.

After confirmation, the material's reserved quantity includes the reservation's planned quantity.

{| class="wikitable"

! Quantity

! Value

|-

| Material.QUANTITY

| 10

|-

| Material.RESERVED_QUANTITY

| 1

|-

| Material.AvailableQuantity()

| 9

|}

=== Step 5: Task is finished ===

When the task is finished, CloseReservations() is called.

The confirmed reservation is changed to Issued.

== Validation and business rules ==

The following business rules are implemented in the inspected material management logic.

{| class="wikitable"

! Area

! Rule

! Implemented by

|-

| Planned reservation quantity

| QTY_PLANNED must be greater than 0.

| AllowQuantityPlanned(double)

|-

| Planned reservation quantity

| QTY_PLANNED can only be changed while the reservation is Planned.

| AllowQuantityPlanned(double)

|-

| Planned reservation quantity

| QTY_PLANNED must not exceed LK_MATERIAL.AvailableQuantity().

| AllowQuantityPlanned(double)

|-

| Actual reservation quantity

| QUANTITY must be greater than 0.

| AllowQuantity(double)

|-

| Actual reservation quantity

| QUANTITY can only be changed while the reservation is Planned or Confirmed.

| AllowQuantity(double)

|-

| Reservation status

| Status cannot be changed once the reservation is Issued.

| AllowStatusChange(int newStatus)

|-

| Reservation status

| A reservation cannot be changed from Confirmed back to Planned.

| AllowStatusChange(int newStatus)

|-

| Reservation links

| LK_TASK and LK_MATERIAL cannot be changed when status is Issued or Confirmed.

| Property setters

|-

| Material deletion

| Material cannot be deleted while QUANTITY is greater than 0.

| InternalDeleteAllowed()

|-

| Material deletion

| Material cannot be deleted while active reservations exist.

| InternalDeleteAllowed() and HasActiveReservation()

|}

MRO Material Management

UBIK Wiki / Augmensys