LogEntryRepositoryInterface.php 1.89 KB
Newer Older
Ketan's avatar
Ketan committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
<?php
/**
 * @copyright  Vertex. All rights reserved.  https://www.vertexinc.com/
 * @author     Mediotype                     https://www.mediotype.com/
 */

namespace Vertex\Tax\Api;

/**
 * Service Contract for retrieving, saving, and removing Vertex log entries
 *
 * @api
 */
interface LogEntryRepositoryInterface
{
    /**
     * Save a Vertex Log Entry
     *
     * @param \Vertex\Tax\Api\Data\LogEntryInterface $logEntry
     * @return \Vertex\Tax\Api\Data\LogEntryInterface
     * @throws \Magento\Framework\Exception\CouldNotSaveException
     */
    public function save(\Vertex\Tax\Api\Data\LogEntryInterface $logEntry);

    /**
     * Retrieve a collection of Vertex Log Entries based on the provided Search Criteria
     *
     * @param \Magento\Framework\Api\SearchCriteriaInterface $searchCriteria
     * @return \Vertex\Tax\Api\Data\LogEntrySearchResultsInterface
     * @throws \Magento\Framework\Exception\LocalizedException
     */
    public function getList(\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria);

    /**
     * Delete a Vertex Log Entry
     *
     * @param \Vertex\Tax\Api\Data\LogEntryInterface $logEntry
     * @return bool true on success
     * @throws \Magento\Framework\Exception\CouldNotDeleteException
     */
    public function delete(\Vertex\Tax\Api\Data\LogEntryInterface $logEntry);

    /**
     * Delete a Vertex Log Entry
     *
     * @param int $logEntryId
     * @return bool true on success
     * @throws \Magento\Framework\Exception\CouldNotDeleteException
     */
    public function deleteById($logEntryId);

    /**
     * Delete multiple records by criteria
     *
     * @param \Magento\Framework\Api\SearchCriteriaInterface $searchCriteria
     * @return bool true on success
     * @throws \Magento\Framework\Exception\CouldNotDeleteException
     */
    public function deleteByCriteria(\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria);
}