ExportEntityRepositoryInterface.php

<?php
/**
 * Copyright © OpenGento, All rights reserved.
 * See LICENSE bundled with this library for license details.
 */
declare(strict_types=1);

namespace Opengento\Gdpr\Api;

use Magento\Framework\Api\SearchCriteriaInterface;
use Magento\Framework\Api\SearchResultsInterface;
use Magento\Framework\Exception\CouldNotDeleteException;
use Magento\Framework\Exception\CouldNotSaveException;
use Magento\Framework\Exception\LocalizedException;
use Magento\Framework\Exception\NoSuchEntityException;
use Opengento\Gdpr\Api\Data\ExportEntityInterface;
use Opengento\Gdpr\Api\Data\ExportEntitySearchResultsInterface;

/**
 * @api
 */
interface ExportEntityRepositoryInterface
{
    /**
     * Save export entity
     *
     * @param ExportEntityInterface $exportEntity
     * @return ExportEntityInterface
     * @throws CouldNotSaveException
     */
    public function save(ExportEntityInterface $exportEntity): ExportEntityInterface;

    /**
     * Retrieve export entity by ID
     *
     * @param int $exportId
     * @return ExportEntityInterface
     * @throws NoSuchEntityException
     */
    public function getById(int $exportId): ExportEntityInterface;

    /**
     * Retrieve export by entity
     *
     * @param int $entityId
     * @param string $entityType
     * @return ExportEntityInterface
     * @throws NoSuchEntityException
     */
    public function getByEntity(int $entityId, string $entityType): ExportEntityInterface;

    /**
     * Retrieve export entity list by search filter criteria
     *
     * @param SearchCriteriaInterface $searchCriteria
     * @return ExportEntitySearchResultsInterface
     * @throws LocalizedException
     */
    public function getList(SearchCriteriaInterface $searchCriteria): SearchResultsInterface;

    /**
     * Delete export entity
     *
     * @param ExportEntityInterface $exportEntity
     * @return bool true on success
     * @throws CouldNotDeleteException
     */
    public function delete(ExportEntityInterface $exportEntity): bool;
}