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 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 <?php
/* --------------------------------------------------------------
OrderStatusServiceInterface.inc.php 2017-03-30
Gambio GmbH
http://www.gambio.de
Copyright (c) 2017 Gambio GmbH
Released under the GNU General Public License (Version 2)
[http://www.gnu.org/licenses/gpl-2.0.html]
--------------------------------------------------------------
*/
/**
* Interface OrderStatusServiceInterface
*
* @category System
* @package OrderStatus
* @subpackage Interfaces
*/
interface OrderStatusServiceInterface
{
/**
* Returns a collection with all order status.
*
* @return OrderStatusCollection Collection of all order status resources.
*/
public function findAll();
/**
* Returns an order status entity by the given order status id. If no data was found, null is returned.
*
* @param \IntType $orderStatusId Id of expected OrderStatus entity.
*
* @return OrderStatus|null Whether the found order status entity or null.
*/
public function find(IntType $orderStatusId);
/**
* Returns an order status entity by the given order status id. If no data was found, an exception is thrown.
*
* @param \IntType $orderStatusId Id of expected OrderStatus entity.
*
* @throws OrderStatusNotFoundException If expected order status entity was not found by the given id.
* @return OrderStatus Expected order status entity.
*/
public function get(IntType $orderStatusId);
/**
* Creates a new order status.
*
* @param \OrderStatus $orderStatus Order status entity with new data.
*
* @return int Id of new order status entity.
*/
public function create(OrderStatus $orderStatus);
/**
* Updates an order status.
*
* @param \OrderStatus $orderStatus Order status entity with updated data.
*
* @return $this|OrderStatusServiceInterface Same instance for chained method calls.
*/
public function update(OrderStatus $orderStatus);
/**
* Removes an order status.
*
* @param \IntType $orderStatusId Id of order status entity to be removed.
*
* @return $this|OrderStatusServiceInterface Same instance for chained method calls.
*/
public function remove(IntType $orderStatusId);
}