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 
<?php
/* --------------------------------------------------------------
   OrderStatusHistoryWriterInterface.inc.php 2017-06-14
   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 OrderStatusHistoryWriterInterface
 *
 * @category   System
 * @package    Order
 * @subpackage Interfaces
 */
interface OrderStatusHistoryWriterInterface
{
    /**
     * Adds an order status history item.
     *
     * @param IdType     $orderId          Order ID.
     * @param IntType    $newOrderStatusId New order status ID.
     * @param StringType $comment          Comment.
     * @param BoolType   $customerNotified Is customer notified?
     * @param IdType     $customerId       Customer ID of the admin account.
     */
    public function addStatusUpdate(IdType $orderId,
                                    IntType $newOrderStatusId,
                                    StringType $comment,
                                    BoolType $customerNotified,
                                    IdType $customerId = null);
    
    
    /**
     * Deletes all order status history items which are associated with the given order item ID.
     *
     * @param IdType $orderId Order ID.
     */
    public function deleteHistory(IdType $orderId);
}