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 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
<?php
/* --------------------------------------------------------------
OrderItemInterface.inc.php 2016-03-15
Gambio GmbH
http://www.gambio.de
Copyright (c) 2016 Gambio GmbH
Released under the GNU General Public License (Version 2)
[http://www.gnu.org/licenses/gpl-2.0.html]
--------------------------------------------------------------
*/
/**
* Interface OrderItemInterface
*
* @category System
* @package Order
* @subpackage Interfaces
*/
interface OrderItemInterface
{
/**
* Returns the product model of the order item.
*
* @return string Product model of the order item.
*/
public function getProductModel();
/**
* Returns the name of the order item.
*
* @return string Name of the order item.
*/
public function getName();
/**
* Returns the price of the order item.
*
* @return double Price of the order item.
*/
public function getPrice();
/**
* Returns the quantity of the order item.
*
* @return double Quantity of the order item.
*/
public function getQuantity();
/**
* Returns the final price of the order item.
*
* @return float Final price of the order item.
*/
public function getFinalPrice();
/**
* Returns the tax of the order item.
*
* @return float Tax of the order item.
*/
public function getTax();
/**
* Is tax of the order item allowed?
*
* @return bool Is tax of the order item allowed?
*/
public function isTaxAllowed();
/**
* Returns the amount of discount of the order item.
*
* @return float Amount of discount of the order item.
*/
public function getDiscountMade();
/**
* Returns the shipping time of the order item.
*
* @return string Shipping time of the order item.
*/
public function getShippingTimeInfo();
/**
* Returns the attributes of the order item.
*
* @return OrderItemAttributeCollection Attributes of the order item.
*/
public function getAttributes();
/**
* Returns the name of quantity unit of the order item.
*
* @return string Name of quantity unit of the order item.
*/
public function getQuantityUnitName();
/**
* Returns the checkout information of the order item.
*
* @return string Checkout information of the order item.
*/
public function getCheckoutInformation();
/**
* Returns the download information collection of the order item.
*
* @return OrderItemDownloadInformationCollection Download information collection of the order item.
*/
public function getDownloadInformation();
/**
* Sets the product model of the order item.
*
* @param StringType $model Model of the order item.
*
* @return OrderItemInterface Same instance for method chaining.
*/
public function setProductModel(StringType $model);
/**
* Sets the name of the order item.
*
* @param StringType $name Name of the order item.
*
* @return OrderItemInterface Same instance for method chaining.
*/
public function setName(StringType $name);
/**
* Sets the price of the order item.
*
* @param DecimalType $price Price of the order item.
*
* @return OrderItemInterface Same instance for method chaining.
*/
public function setPrice(DecimalType $price);
/**
* Sets the quantity of the order item.
*
* @param DecimalType $quantity Quantity of the order item.
*
* @return OrderItemInterface Same instance for method chaining.
*/
public function setQuantity(DecimalType $quantity);
/**
* Sets the tax of the order item.
*
* @param DecimalType $tax Tax of the order item.
*
* @return OrderItemInterface Same instance for method chaining.
*/
public function setTax(DecimalType $tax);
/**
* Sets whether tax of the OrderItem is allowed or not.
*
* @param BoolType $allow Tax allowed or not?
*
* @return OrderItemInterface Same instance for method chaining.
*/
public function setTaxAllowed(BoolType $allow);
/**
* Sets the discount of the order item.
*
* @param DecimalType $discount Discount of the order item.
*
* @return OrderItemInterface Same instance for method chaining.
*/
public function setDiscountMade(DecimalType $discount);
/**
* Sets the shipping time of the order item.
*
* @param StringType $time Shipping time of the order item.
*
* @return OrderItemInterface Same instance for method chaining.
*/
public function setShippingTimeInfo(StringType $time);
/**
* Sets the attributes of the order item.
*
* @param OrderItemAttributeCollection $attributeCollection Attributes of the order item.
*
* @return OrderItemInterface Same instance for method chaining.
*/
public function setAttributes(OrderItemAttributeCollection $attributeCollection);
/**
* Sets the name of quantity unit of the order item.
*
* @param StringType $name Name of quantity unit of the order item.
*
* @return OrderItemInterface Same instance for method chaining.
*/
public function setQuantityUnitName(StringType $name);
/**
* Sets the checkout information.
*
* @param StringType $checkoutInformation Contains the checkout info of the order item.
*
* @return OrderItemInterface Same instance for method chaining.
*/
public function setCheckoutInformation(StringType $checkoutInformation);
/**
* Sets the download information of the order item.
*
* @param OrderItemDownloadInformationCollection $downloads Download information collection of the order item.
*
* @return OrderItemInterface Same instance for method chaining.
*/
public function setDownloadInformation(OrderItemDownloadInformationCollection $downloads);
/**
* Returns the addon collection of the order item.
*
* @return EditableKeyValueCollection The addon collection of the order item.
*/
public function getAddonValues();
/**
* Returns the order addon key value from collection.
*
* @param StringType $key Addon key.
*
* @throws InvalidArgumentException On invalid arguments.
* @return string Addon value.
*/
public function getAddonValue(StringType $key);
/**
* Adds/updates a key value in the addon value collection.
*
* @param StringType $key Addon key.
* @param StringType $value Addon value.
*
* @return OrderItemInterface Same instance for method chaining.
*/
public function setAddonValue(StringType $key, StringType $value);
/**
* Merges the existing addon values with new ones.
*
* @param KeyValueCollection $addonValues Contains the new addon values to be merged with the existing ones.
*
* @return OrderItemInterface Same instance for method chaining.
*/
public function addAddonValues(KeyValueCollection $addonValues);
/**
* Deletes a specific addon value entry by key.
*
* @param StringType $key Addon key.
*
* @return OrderItemInterface Same instance for method chaining.
*/
public function deleteAddonValue(StringType $key);
}