OrderItemInterface.php 2.99 KB
Newer Older
Ketan's avatar
Ketan committed
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 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
<?php
/**
 * Refer to LICENSE.txt distributed with the Temando Shipping module for notice of license
 */
namespace Temando\Shipping\Model\Order;

/**
 * Temando Order Item Interface
 *
 * An order item as associated with an order entity at the Temando platform.
 *
 * @package  Temando\Shipping\Model
 * @author   Christoph Aßmann <christoph.assmann@netresearch.de>
 * @license  http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link     http://www.temando.com/
 */
interface OrderItemInterface
{
    const PRODUCT_ID = 'product_id';
    const QTY = 'qty';
    const SKU = 'sku';
    const NAME = 'name';
    const DESCRIPTION = 'description';
    const CATEGORIES = 'categories';

    const DIMENSIONS_UOM = 'dimensions_uom';
    const LENGTH = 'length';
    const WIDTH = 'width';
    const HEIGHT = 'height';
    const WEIGHT_UOM = 'weight_uom';
    const WEIGHT = 'weight';
    const CURRENCY = 'currency';
    const AMOUNT = 'amount';

    const IS_FRAGILE = 'is_fragile';
    const IS_VIRTUAL = 'is_virtual';
    const IS_PREPACKAGED = 'is_prepackaged';
    const CAN_ROTATE_VERTICAL = 'can_rotate_vertical';

    const COUNTRY_OF_ORIGIN = 'country_of_origin';
    const COUNTRY_OF_MANUFACTURE = 'country_of_manufacture';
    const ECCN = 'eccn';
    const SCHEDULE_B_INFO = 'schedule_b_info';
    const HS_CODE = 'hs_code';

    /**
     * @return int
     */
    public function getProductId();

    /**
     * @return int
     */
    public function getQty();

    /**
     * @return string
     */
    public function getSku();

    /**
     * @return string
     */
    public function getName();

    /**
     * @return string
     */
    public function getDescription();

    /**
     * @return string[]
     */
    public function getCategories();

    /**
     * @return string
     */
    public function getDimensionsUom();

    /**
     * @return float
     */
    public function getLength();

    /**
     * @return float
     */
    public function getWidth();

    /**
     * @return float
     */
    public function getHeight();

    /**
     * @return string
     */
    public function getWeightUom();

    /**
     * @return float
     */
    public function getWeight();

    /**
     * @return string
     */
    public function getCurrency();

    /**
     * @return float
     */
    public function getAmount();

    /**
     * @return bool
     */
    public function isFragile();

    /**
     * @return bool
     */
    public function isVirtual();

    /**
     * @return bool
     */
    public function isPrePackaged();

    /**
     * @return bool
     */
    public function canRotateVertically();

    /**
     * @return string
     */
    public function getCountryOfOrigin();

    /**
     * @return string
     */
    public function getCountryOfManufacture();

    /**
     * @return string
     */
    public function getEccn();

    /**
     * @return string
     */
    public function getScheduleBinfo();

    /**
     * @return string
     */
    public function getHsCode();
}