1 <?php
2
3 /* --------------------------------------------------------------
4 OrderStatusHistoryWriterInterface.inc.php 2015-12-17
5 Gambio GmbH
6 http://www.gambio.de
7 Copyright (c) 2015 Gambio GmbH
8 Released under the GNU General Public License (Version 2)
9 [http://www.gnu.org/licenses/gpl-2.0.html]
10 --------------------------------------------------------------
11 */
12
13 /**
14 * Interface OrderStatusHistoryWriterInterface
15 *
16 * @category System
17 * @package Order
18 * @subpackage Interfaces
19 */
20 interface OrderStatusHistoryWriterInterface
21 {
22 /**
23 * Adds an order status history item.
24 *
25 * @param IdType $orderId Order ID.
26 * @param IdType $newOrderStatusId New order status ID.
27 * @param StringType $comment Comment.
28 * @param BoolType $customerNotified Is customer notified?
29 */
30 public function addStatusUpdate(IdType $orderId,
31 IdType $newOrderStatusId,
32 StringType $comment,
33 BoolType $customerNotified);
34
35
36 /**
37 * Deletes all order status history items which are associated with the given order item ID.
38 *
39 * @param IdType $orderId Order ID.
40 */
41 public function deleteHistory(IdType $orderId);
42 }