LogEntryRepositoryInterface.php 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  1. <?php
  2. /**
  3. * @copyright Vertex. All rights reserved. https://www.vertexinc.com/
  4. * @author Mediotype https://www.mediotype.com/
  5. */
  6. namespace Vertex\Tax\Api;
  7. /**
  8. * Service Contract for retrieving, saving, and removing Vertex log entries
  9. *
  10. * @api
  11. */
  12. interface LogEntryRepositoryInterface
  13. {
  14. /**
  15. * Save a Vertex Log Entry
  16. *
  17. * @param \Vertex\Tax\Api\Data\LogEntryInterface $logEntry
  18. * @return \Vertex\Tax\Api\Data\LogEntryInterface
  19. * @throws \Magento\Framework\Exception\CouldNotSaveException
  20. */
  21. public function save(\Vertex\Tax\Api\Data\LogEntryInterface $logEntry);
  22. /**
  23. * Retrieve a collection of Vertex Log Entries based on the provided Search Criteria
  24. *
  25. * @param \Magento\Framework\Api\SearchCriteriaInterface $searchCriteria
  26. * @return \Vertex\Tax\Api\Data\LogEntrySearchResultsInterface
  27. * @throws \Magento\Framework\Exception\LocalizedException
  28. */
  29. public function getList(\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria);
  30. /**
  31. * Delete a Vertex Log Entry
  32. *
  33. * @param \Vertex\Tax\Api\Data\LogEntryInterface $logEntry
  34. * @return bool true on success
  35. * @throws \Magento\Framework\Exception\CouldNotDeleteException
  36. */
  37. public function delete(\Vertex\Tax\Api\Data\LogEntryInterface $logEntry);
  38. /**
  39. * Delete a Vertex Log Entry
  40. *
  41. * @param int $logEntryId
  42. * @return bool true on success
  43. * @throws \Magento\Framework\Exception\CouldNotDeleteException
  44. */
  45. public function deleteById($logEntryId);
  46. /**
  47. * Delete multiple records by criteria
  48. *
  49. * @param \Magento\Framework\Api\SearchCriteriaInterface $searchCriteria
  50. * @return bool true on success
  51. * @throws \Magento\Framework\Exception\CouldNotDeleteException
  52. */
  53. public function deleteByCriteria(\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria);
  54. }