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 

<?php

/* --------------------------------------------------------------
   OrderStatusInterface.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 OrderStatusInterface
 *
 * @category   System
 * @package    OrderStatus
 * @subpackage Entities
 */
interface OrderStatusInterface
{
    /**
     * Returns the order status id.
     *
     * @return int|null
     */
    public function getId();
    
    
    /**
     * Returns the order status names.
     *
     * @return array Order status names.
     */
    public function getNames();
    
    
    /**
     * Returns the order status name by the given language id.
     *
     * @param LanguageCode $languageCode Expected language code.
     *
     * @return string Expected status name by given language id.
     * @throws Exception If no name exists by the given language code.
     */
    public function getName(LanguageCode $languageCode);
    
    
    /**
     * Sets the order status name.
     *
     * @param \LanguageCode $languageCode Language code of order status name.
     * @param \StringType   $name         Order status name.
     *
     * @return $this|OrderStatus Same instance for chained method calls.
     */
    public function setName(LanguageCode $languageCode, StringType $name);
    
    
    /**
     * Returns the order status label-color.
     *
     * @return string Color of order status label.
     */
    public function getColor();
    
    
    /**
     * Sets the order status label-color.
     *
     * @param StringType $color New color of order status label.
     *
     * @return $this|OrderStatus Same instance for chained method calls.
     */
    public function setColor(StringType $color);
}