All Superinterfaces:
Collection<Catalog.Card>, Iterable<Catalog.Card>
All Known Subinterfaces:
CatalogAccessor

@ForUseOnly public interface Catalog extends Collection<Catalog.Card>
Container value holding an arbitrary number of unique cards.
Since:
5.2.6
See Also:
  • Method Details

    • find

      @ApiDoc(comment="Search for a card with a given identifier.", since="5.2.181202") @NotNull default @NotNull Optional<Catalog.Card> find(@NotNull @NotNull UUID uuid)
      Search for a card with the specified unique identifier.
      Parameters:
      uuid - The identifier to return the card for.
      Returns:
      The matching card, if there is any.
      Since:
      5.2.181202
    • create

      @ApiDoc(comment="Factory method to create a new card based on the given template and form data.", since="5.2.6") @NotNull @NotNull Catalog.Card create(@NotNull @NotNull Template template, @Nullable @Nullable FormData formData)
      Factory method to create a new card based on the given template and form data. If no form data is given, the card will be created with an empty item.
      Note: Later changes to the given form data will not reflect in the data held by the card.

      Important:
      The created card will not be added to the catalog. To add the created card, use add(card).
      Parameters:
      template - The template.
      formData - The form data, if available, or null.
      Returns:
      The newly created card.
      Since:
      5.2.6