1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859 |
- <?php
- /**
- * Copyright © Magento, Inc. All rights reserved.
- * See COPYING.txt for license details.
- */
- namespace Magento\SalesRule\Api;
- /**
- * Sales rule CRUD interface
- *
- * @api
- * @since 100.0.2
- */
- interface RuleRepositoryInterface
- {
- /**
- * Save sales rule.
- *
- * @param \Magento\SalesRule\Api\Data\RuleInterface $rule
- * @return \Magento\SalesRule\Api\Data\RuleInterface
- * @throws \Magento\Framework\Exception\InputException If there is a problem with the input
- * @throws \Magento\Framework\Exception\NoSuchEntityException If a rule ID is sent but the rule does not exist
- * @throws \Magento\Framework\Exception\LocalizedException
- */
- public function save(\Magento\SalesRule\Api\Data\RuleInterface $rule);
- /**
- * Get rule by ID.
- *
- * @param int $ruleId
- * @return \Magento\SalesRule\Api\Data\RuleInterface
- * @throws \Magento\Framework\Exception\NoSuchEntityException If $id is not found
- * @throws \Magento\Framework\Exception\LocalizedException
- */
- public function getById($ruleId);
- /**
- * Retrieve sales rules that match te specified criteria.
- *
- * This call returns an array of objects, but detailed information about each object’s attributes might not be
- * included. See https://devdocs.magento.com/codelinks/attributes.html#RuleRepositoryInterface to
- * determine which call to use to get detailed information about all attributes for an object.
- *
- * @param \Magento\Framework\Api\SearchCriteriaInterface $searchCriteria
- * @return \Magento\SalesRule\Api\Data\RuleSearchResultInterface
- * @throws \Magento\Framework\Exception\LocalizedException
- */
- public function getList(\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria);
- /**
- * Delete rule by ID.
- *
- * @param int $ruleId
- * @return bool true on success
- * @throws \Magento\Framework\Exception\NoSuchEntityException
- * @throws \Magento\Framework\Exception\LocalizedException
- */
- public function deleteById($ruleId);
- }
|