aswi2022code-of-duty-gitlab/backend/src/main/java/cz/zcu/kiv/backendapi/catalog/ICatalogItemService.java @ b539ef29

package cz.zcu.kiv.backendapi.catalog;

import cz.zcu.kiv.backendapi.path.PathDto;

import java.util.List;
import java.util.UUID;

/**
 * Catalog service interface
 */
public interface ICatalogItemService {
    /**
     * Saves list of catalog items
     *
     * @param catalogItems catalog items
     */
    void saveCatalog(List<CatalogItem> catalogItems);

    /**
     * Saves one catalog item
     *
     * @param catalogItemDto catalog item DTO
     */
    void saveCatalogItem(CatalogItemDto catalogItemDto);

    /**
     * Updates catalog item with given ID
     *
     * @param id             ID
     * @param catalogItemDto catalog item DTO
     */
    void updateCatalogItem(UUID id, CatalogItemDto catalogItemDto);

    /**
     * Deletes catalog item with given ID
     *
     * @param id ID
     */
    void deleteCatalogItem(UUID id);

    /**
     * Returns catalog items satisfying given filter
     *
     * @param name    name - optional
     * @param country country - optional
     * @param type    type - optional
     * @return list of catalog items satisfying given filter
     */
    List<CatalogItemDto> getCatalog(String name, String country, String type);

    /**
     * Returns catalog item with given ID
     *
     * @param id ID
     * @return catalog item with given ID
     */
    CatalogItemDto getCatalogItem(UUID id);

    /**
     * Returns highlighted searched text and searched items
     *
     * @param text text
     * @return highlighted searched text and searched items
     */
    PathDto getPath(String text);

}