1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374 |
- <?php
- /**
- * Copyright © Magento, Inc. All rights reserved.
- * See COPYING.txt for license details.
- */
- namespace Magento\Customer\Api;
- /**
- * Customer group CRUD interface
- * @api
- * @since 100.0.2
- */
- interface GroupRepositoryInterface
- {
- /**
- * Save customer group.
- *
- * @param \Magento\Customer\Api\Data\GroupInterface $group
- * @return \Magento\Customer\Api\Data\GroupInterface
- * @throws \Magento\Framework\Exception\InputException If there is a problem with the input
- * @throws \Magento\Framework\Exception\NoSuchEntityException If a group ID is sent but the group does not exist
- * @throws \Magento\Framework\Exception\State\InvalidTransitionException
- * If saving customer group with customer group code that is used by an existing customer group
- * @throws \Magento\Framework\Exception\LocalizedException
- */
- public function save(\Magento\Customer\Api\Data\GroupInterface $group);
- /**
- * Get customer group by group ID.
- *
- * @param int $id
- * @return \Magento\Customer\Api\Data\GroupInterface
- * @throws \Magento\Framework\Exception\NoSuchEntityException If $groupId is not found
- * @throws \Magento\Framework\Exception\LocalizedException
- */
- public function getById($id);
- /**
- * Retrieve customer groups.
- *
- * The list of groups can be filtered to exclude the NOT_LOGGED_IN group using the first parameter and/or it can
- * be filtered by tax class.
- *
- * 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#GroupRepositoryInterface to determine
- * which call to use to get detailed information about all attributes for an object.
- *
- * @param \Magento\Framework\Api\SearchCriteriaInterface $searchCriteria
- * @return \Magento\Customer\Api\Data\GroupSearchResultsInterface
- * @throws \Magento\Framework\Exception\LocalizedException
- */
- public function getList(\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria);
- /**
- * Delete customer group.
- *
- * @param \Magento\Customer\Api\Data\GroupInterface $group
- * @return bool true on success
- * @throws \Magento\Framework\Exception\StateException If customer group cannot be deleted
- * @throws \Magento\Framework\Exception\LocalizedException
- */
- public function delete(\Magento\Customer\Api\Data\GroupInterface $group);
- /**
- * Delete customer group by ID.
- *
- * @param int $id
- * @return bool true on success
- * @throws \Magento\Framework\Exception\NoSuchEntityException
- * @throws \Magento\Framework\Exception\StateException If customer group cannot be deleted
- * @throws \Magento\Framework\Exception\LocalizedException
- */
- public function deleteById($id);
- }
|