# Relacja transport czeka na (HAS\_TO\_WAIT\_FOR)

## Opis wiązania

Typ łączenia opisany jest klasą `TransportRelationHasToWaitFor`. Aby zaawizować transport główny, wszystkie połączone z nim transporty zależne, muszą posiadać okna czasowe i awizację. Okno czasowe transportu głównego, nie może zaczynać się wcześniej niż koniec najpóźniejszego okna w transportach zależnych.

W klasie opisującej łączenie mamy kilka parametrów, za pomocą których możemy sterować pewnymi zachowaniami powiązania:

- Opóźnienie awizacji okna zależnego (`minutesAddedToTimeWindowValidation`) - jest to ilość minut dodawana do czasu najpóźniejszego okna w transportach zależnych przed sprawdzeniem poprawności daty awizacji transportu głównego. (czyli transport główny nie może być awizowany wcześniej niż najpóźniejsze okno z transportów zależnych, plus ilość minut z tego parametru).
- Możliwość powiązania tylko jak jest ten sam magazyn (`requiresTheSameWarehouseInDifferentStepType`): Jeżeli ta flaga będzie włączona, to przy tworzeniu wiązania można połączyć tylko i wyłącznie te transporty, w których występuje ten sam magazyn w przeciwnym typie stepu.

> Przykład: Przy włączonej fladze, możemy połączyć tylko te transporty, które mają ten sam magazyn w przeciwnym typie stepu:
>
> ![Same warehouse 1](<https://docs.logintegra.com/apollo-backend/static/Transports/special-features/has-to-wait-for/has-to-wait-for-same-warehouse-1.png>)
>
> ![Same warehouse 2](<https://docs.logintegra.com/apollo-backend/static/Transports/special-features/has-to-wait-for/has-to-wait-for-same-warehouse-2.png>)

- Usunięcie relacji przy usunięciu transportu głównego (`deleteRelationIfMasterDeleted`): Jeżeli ta flaga będzie włączona, po usunięciu transportu głównego, usuniemy również powiązane z nim relacje.
- Pozostawienie relacji w przypadku usunięcia transportu zależnego (`setNullOnRelatedTransportDelete`): Jeżeli ta flaga będzie włączona po usunięciu transportu zależnego, relacja nie usunie się. Zamiast tego transport główny będzie oczekiwał na utworzenie transportu zależnego o takim samym identyfikatorze jak usunięty transport, a po utworzeniu takiego transportu powiązanie zostanie utworzone automatycznie.

## Uprawnienia i ustawienia

Aby dodawać powiązanie tego typu w platformie, użytkownik musi mieć uprawnienia 'Dodawanie powiązania relacji pomiędzy transportami'(`Authority#ROLE_CAN_ADD_HAS_TO_WAIT_FOR_RELATION`) w obu typach transportów biorących udział w relacji.

## Dodawanie powiązań

Sterowanie powiązaniami i flagą może odbywać się przez platformę lub przez PublicAPI.

### Platforma

Dodawanie tego typu powiązania z poziomu GUI odbywa się w widoku `Wszystkie` (gdyż łączymy ze sobą różne typy transportów). Jeśli użytkownik ma odpowiednie uprawnienia oraz w tabeli `transport_relation` znajdują się odpowiednie wpisy, to przy każdym niepowiązanym transporcie głównym (`TransportRelation#primaryTransportType`) pojawią się czekboxy:

![Nothing selected](<https://docs.logintegra.com/apollo-backend/static/Transports/special-features/has-to-wait-for/has-to-wait-for-not-selected.png>)

Zaznaczenie pierwszego transportu definiuje transport główny, kolejne zaznaczone transporty zostaną dodane do relacji jako transporty zależne. Po zaznaczeniu transportu głównego platforma pokaże checkboxy w transportach zależnych, z którymi można dodać wiązanie:

![Master selected](<https://docs.logintegra.com/apollo-backend/static/Transports/special-features/has-to-wait-for/has-to-wait-for-master-selected.png>)

Po zaznaczeniu więcej niż jednego transportu, na dole tabeli powinien pojawić się przycisk "Utwórz powiązanie":

![All selected](<https://docs.logintegra.com/apollo-backend/static/Transports/special-features/has-to-wait-for/has-to-wait-for-all-selected.png>)

Po kliknięciu przycisku wyświetli się modal, w którym będziemy widzieć opis możliwych dla nas powiązań:

![Modal](<https://docs.logintegra.com/apollo-backend/static/Transports/special-features/has-to-wait-for/has-to-wait-for-modal.png>)

Po wyborze i potwierdzeniu przyciskiem "Utwórz powiązanie" transporty zostaną połączone:

![Transports combined](<https://docs.logintegra.com/apollo-backend/static/Transports/special-features/has-to-wait-for/has-to-wait-for-done.png>)

### PublicAPI

#### Tworzenie nowego transportu

Przy tworzeniu nowego transportu głównego możemy od razu podać jeden lub więcej transportów zależnych w bloku `relatedTo`. Transporty zależne mogą istnieć już w platformie (wtedy w bloku `relatedTo` możemy używac `id`, `erpIdentifiier` lub `altIdentifier`) lub możemy utworzyć powiązanie z nieistniejącymi jeszcze transportami zależnymi (w takim przypadku musimy użyc `erpIdentifier` lub `altIdentifier`) Po utworzeniu transportu zależnego, połączy się on z wszystkimi transportami głównymi powiązanych z jego identyfikatorem.

Przykładowo: W systemie istnieje tylko jedno `Wahadło` z `erpIdentifier` `WAH_1`, bez żadnych powiązań:

![New transport](<https://docs.logintegra.com/apollo-backend/static/Transports/special-features/has-to-wait-for/new-transport-no-relations.png>)

Utworzymy przez `PublicAPI` dwa nowe `Załadunki`: 1) `Zaladunek` `ZAL_1` powiązany z `Wahadłem` `WAH_1` i nie istniejącym jeszcze `Wahadłem` `WAH_2`

> Uwaga: W przypadku nieutworzonych jeszcze transportów, w nagłówkach zamiast hiperłącz przenoszących do danego transportu zależnego, widzimy szare identyfikatory.

![First master](<https://docs.logintegra.com/apollo-backend/static/Transports/special-features/has-to-wait-for/first-master.png>)

```
{
  "erpIdentifier": "ZAL_1",
  "description": "OPIS 2222",
  "principalCompany": {
    "id": 268138707,
    "alias": "atlas"
  },
  "carrierCompany": {
    "contractorNumber": "062848"
  },
  "transportType": {
    "id": 268143530,
    "Name": "LOADING"
  },
  "readyToPlan": false,
  "steps": [
    {
      "orderInTransport": 0,
      "stepTypeName": "load",
      "warehouse": {
        "id": 268140434,
        "name": "Magazyn Atlas Zgierz"
      }
    },
    {
      "orderInTransport": 1,
      "stepTypeName": "unload",
      "company": {
        "id": "268205742"
      },
      "address": {
        "recipient": "Test",
        "street": "Testowa",
        "postal": "11-111",
        "city": "Testowo",
        "country": "PL"
      }
    }
  ],
  "customFields": [
    {
      "definitionName": "Środek transportu",
      "definitionEnglishName": "Mode of transportation",
      "value": "Chłodnia"
    },
    {
      "definitionName": "Rodzaj zlecenia",
      "definitionEnglishName": "Type of order",
      "value": "Drobnica"
    },
    {
      "definitionName": "Oczekuje na wahadło",
      "definitionEnglishName": "Waiting for inter-warehouse transport?",
      "value": "Tak"
    },
    {
      "definitionName": "Dystans [km]",
      "definitionEnglishName": "Distance [km]",
      "value": "280"
    },
    {
      "definitionName": "Koszt",
      "definitionEnglishName": "Cost",
      "value": "1854.71"
    },
    {
      "definitionName": "Waluta kosztu",
      "definitionEnglishName": "Cost currency",
      "value": "PLN"
    }
  ],
  "relatedTo": [
    {
      "erpIdentifier": "WAH_1",
      "dependencyType": "HAS_TO_WAIT_FOR"
    },
    {
      "erpIdentifier": "WAH_2",
      "dependencyType": "HAS_TO_WAIT_FOR"
    }
  ]
}

}
```

2\) `Załadunek` `ZAL_2` powiązany tylko z nie istniejącym jeszcze `Wahadłem` `WAH_2`

![Second master](<https://docs.logintegra.com/apollo-backend/static/Transports/special-features/has-to-wait-for/second-master.png>)

```
{
  "erpIdentifier": "ZAL_2",
  "description": "OPIS 2222",
  "principalCompany": {
    "id": 268138707,
    "alias": "atlas"
  },
  "carrierCompany": {
    "contractorNumber": "062848"
  },
  "transportType": {
    "id": 268143530,
    "Name": "LOADING"
  },
  "readyToPlan": false,
  "steps": [
    {
      "orderInTransport": 0,
      "stepTypeName": "load",
      "warehouse": {
        "id": 268140434,
        "name": "Magazyn Atlas Zgierz"
      }
    },
    {
      "orderInTransport": 1,
      "stepTypeName": "unload",
      "company": {
        "id": "268205742"
      },
      "address": {
        "recipient": "Test",
        "street": "Testowa",
        "postal": "11-111",
        "city": "Testowo",
        "country": "PL"
      }
    }
  ],
  "customFields": [
    {
      "definitionName": "Środek transportu",
      "definitionEnglishName": "Mode of transportation",
      "value": "Chłodnia"
    },
    {
      "definitionName": "Rodzaj zlecenia",
      "definitionEnglishName": "Type of order",
      "value": "Drobnica"
    },
    {
      "definitionName": "Oczekuje na wahadło",
      "definitionEnglishName": "Waiting for inter-warehouse transport?",
      "value": "Tak"
    },
    {
      "definitionName": "Dystans [km]",
      "definitionEnglishName": "Distance [km]",
      "value": "280"
    },
    {
      "definitionName": "Koszt",
      "definitionEnglishName": "Cost",
      "value": "1854.71"
    },
    {
      "definitionName": "Waluta kosztu",
      "definitionEnglishName": "Cost currency",
      "value": "PLN"
    }
  ],
  "relatedTo": [
    {
      "erpIdentifier": "WAH_2",
      "dependencyType": "HAS_TO_WAIT_FOR"
    }
  ]
}

}
```

Oba załadunki utworzyły się od razu z wymaganymi powiązaniami.

![Both masters](<https://docs.logintegra.com/apollo-backend/static/Transports/special-features/has-to-wait-for/both-masters.png>)

Następnie utworzymy `Wahadło`(`WAH_2`), które automycznie powiąże się z oboma wcześniej utworzonymi `Załadunkami` (`ZAL_1`, `ZAL_2`):

![Related transport](<https://docs.logintegra.com/apollo-backend/static/Transports/special-features/has-to-wait-for/related-two-masters.png>)

```
{
  "erpIdentifier": "WAH_1",
  "description": "OPIS 2222",
  "principalCompany": {
    "id": 268138707,
    "alias": "atlas"
  },
  "carrierCompany": {
    "contractorNumber": "062848"
  },
  "transportType": {
    "id": 268337219,
    "Name": "INTER_WAREHOUSE"
  },
  "steps": [
    {
      "orderInTransport": 0,
      "stepTypeName": "load",
      "warehouse": {
        "id": 270416160,
        "name": "Magazyn Atlas Bydgoszcz"
      }
    },
    {
      "orderInTransport": 1,
      "stepTypeName": "unload",
      "warehouse": {
        "id": 268140434,
        "name": "Magazyn Atlas Zgierz"
      }
    }
  ],
  "customFields": [
    {
      "definitionName": "Środek transportu",
      "definitionEnglishName": "Mode of transportation",
      "value": "Chłodnia"
    },
    {
      "definitionName": "Rodzaj zlecenia",
      "definitionEnglishName": "Type of order",
      "value": "Wahadło"
    },
    {
      "definitionName": "Oczekuje na wahadło",
      "definitionEnglishName": "Waiting for inter-warehouse transport?",
      "value": "Nie"
    },
    {
      "definitionName": "Dystans [km]",
      "definitionEnglishName": "Distance [km]",
      "value": "280"
    },
    {
      "definitionName": "Koszt",
      "definitionEnglishName": "Cost",
      "value": "1854.71"
    },
    {
      "definitionName": "Waluta kosztu",
      "definitionEnglishName": "Cost currency",
      "value": "PLN"
    }
  ]
}
```

> Uwaga: Jak widać żądanie utworzenia wahadła, nie musi mieć żadnych dodatkowych węzłów. Powiązanie zostanie automatycznie utworzone na podstawie identyfikatora nowo utworzonego transportu (w tym przypadku erpIdentifier)

![First master with second related](<https://docs.logintegra.com/apollo-backend/static/Transports/special-features/has-to-wait-for/first-master-second-related.png>)

![Second master withrelated](<https://docs.logintegra.com/apollo-backend/static/Transports/special-features/has-to-wait-for/second-master-related.png>)

![All related transports](<https://docs.logintegra.com/apollo-backend/static/Transports/special-features/has-to-wait-for/all-relateds.png>)

#### Edycja istniejącego transportu

- Aby dodać nowe powiązanie, należy wysłać komunikat: PATCH /api/transports/$id

```
{
  "relatedTo": [
    {
      "id": "",
      "altIdentifier": "",
      "erpIdentifier": "WAH_1",
      "dependencyType": "HAS_TO_WAIT_FOR"
    }
  ]
}
```

> Uwaga: pola 'id' (w przypadku istniejących już transportów), 'altIdentifier' oraz 'erpIdentifier' dotyczą transportu, który chcemy podpiąć. Podanie wszystkich pól nie jest wymagane, ale zawsze musi być podane chociaż jedno z nich. Pozostałe mogą być puste (jak w przykładzie) lub może ich nie być w ogóle.

#### Usuwanie powiązań

- Aby usunąć powiązanie, należy wysłać komunikat:

  ```
  DELETE /api/transports/${masterTransportId}/relates/${relatedTransportId}
  ```
