Cykl życia etykiet

Etykiety, pola i wybory przechodzą przez życie przez określone stany. Poza tym etykiety mogą mieć różne wersje. Na diagramie poniżej widać cykl życia etykiet, w tym ich sprawdzanie:

Diagram cyklu życia etykiet.
Rysunek 3. Cykl życia etykiety
  1. Utwórz etykietę (create()) – etykieta zostanie utworzona i zapisana w bazie danych jako revision_id=1. Etykieta ma stan UNPUBLISHED_DRAFT. W tym stanie:
    • Użytkownicy nie mogą zobaczyć etykiety
    • Użytkownicy nie mogą stosować tej etykiety do elementów na Dysku.
  2. (Opcjonalnie) Zaktualizuj etykietę, pole lub wybór (delta()) – każda aktualizacja, nawet przed jej opublikowaniem, jest przechowywana w bazie danych, a liczba wersji etykiety zwiększa się.
  3. Opublikuj etykietę (publish()) – etykieta ma stan PUBLISHED, a użytkownicy mogą ją zastosować. Opublikowanie etykiety zwiększa jej wersję.
  4. (Opcjonalnie) Zaktualizuj etykietę, pole lub opcję (delta()) – etykieta, pole lub wybór zostaną zaktualizowane i zapisane w bazie danych jako etykieta robocza. Etykieta ma stan PUBLISHED, gdzie hasUnpublishedChanges=true oznacza, że występują zmiany w wersji roboczej, ale nie są one dostępne dla użytkowników. Każda aktualizacja zwiększa wersję etykiety.
  5. (Opcjonalnie) Opublikuj etykietę (publish()) – jeśli ta opcja jest dostępna, zostanie opublikowana najnowsza wersja robocza. Etykieta ma stan PUBLISHED, a użytkownicy mogą ją zastosować. Opublikowanie etykiety powoduje zwiększenie jej wersji.
  6. Wyłącz etykietę (disable()) – etykieta ma stan DISABLED, ale użytkownicy mogą ją stosować za pomocą interfejsu API. Jednak wyłączona etykieta nie jest widoczna w interfejsie, jeśli nie została skonfigurowana tak, aby była widoczna. Wycofanie etykiety powoduje zwiększenie liczby jej wersji.
  7. Włącz etykietę (enable()) – etykieta zostanie zwrócona do stanu PUBLISHED, a użytkownicy będą mogli ją zastosować. Opublikowanie etykiety zwiększa jej wersję.
  8. Usuń etykietę (delete()) – etykieta ma stan DELETED i nie można jej zastosować. Usunięte etykiety są ostatecznie trwale usuwane.

Należy podkreślić, że każda aktualizacja etykiety zwiększa jej wersję. Jeśli etykieta została już opublikowana, ponowne opublikowanie jej po zaktualizowaniu n oznacza, że numer opublikowanej wersji to wersja + n + 1 liczba kolejnych aktualizacji.