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 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459
<?php
/* --------------------------------------------------------------
OrderInterface.inc.php 2016-07-11
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 OrderInterface
*
* @category System
* @package Order
* @subpackage Interfaces
*/
interface OrderInterface
{
/**
* Returns the order ID.
*
* @return int Order ID.
*/
public function getOrderId();
/**
* Returns the unique order hash.
*
* @return string Unique order hash.
*/
public function getOrderHash();
/**
* Returns the associated customer ID.
*
* @return int Associated customer ID.
*/
public function getCustomerId();
/**
* Returns the associated customer email address.
*
* @return string Associated customer email address.
*/
public function getCustomerEmail();
/**
* Returns the associated customer telephone number.
*
* @return string Associated customer telephone number.
*/
public function getCustomerTelephone();
/**
* Returns the order status ID.
*
* @return int Order status ID.
*/
public function getStatusId();
/**
* Sets customer number of Order
*
* @param StringType $customerNumber Customer number.
*
* @return OrderInterface Same instance for method chaining.
*/
public function setCustomerNumber(StringType $customerNumber);
/**
* Returns the customer number.
*
* @return string Customer number.
*/
public function getCustomerNumber();
/**
* Sets the VAT ID Number.
*
* @param StringType $vatIdNumber VAT ID number.
*
* @return OrderInterface Same instance for method chaining.
*/
public function setVatIdNumber(StringType $vatIdNumber);
/**
* Returns the VAT ID number.
*
* @return string VAT ID number.
*/
public function getVatIdNumber();
/**
* Sets the customer status information.
*
* @param CustomerStatusInformation $customerStatusInformation Customer status information.
*/
public function setCustomerStatusInformation(CustomerStatusInformation $customerStatusInformation);
/**
* Returns the Customer status information.
*
* @return CustomerStatusInformation Customer status information.
*/
public function getCustomerStatusInformation();
/**
* Returns the customer address.
*
* @return AddressBlockInterface Customer address.
*/
public function getCustomerAddress();
/**
* Returns the billing address.
*
* @return AddressBlockInterface Billing address.
*/
public function getBillingAddress();
/**
* Returns the delivery address.
*
* @return AddressBlockInterface Delivery address.
*/
public function getDeliveryAddress();
/**
* Returns the order items collection.
*
* @return OrderItemCollection Order items collection.
*/
public function getOrderItems();
/**
* Returns the order totals collection.
*
* @return OrderTotalCollection Order totals collection.
*/
public function getOrderTotals();
/**
* Returns the order shipping type.
*
* @return OrderShippingType Order shipping type.
*/
public function getShippingType();
/**
* Returns the order payment type.
*
* @return OrderPaymentType Order payment type.
*/
public function getPaymentType();
/**
* Returns the order currency code.
*
* @return CurrencyCode Order currency code.
*/
public function getCurrencyCode();
/**
* Returns the order language code.
*
* @return LanguageCode Order language code.
*/
public function getLanguageCode();
/**
* Returns the order purchase datetime.
*
* @return DateTime Order purchase datetime.
*/
public function getPurchaseDateTime();
/**
* Returns the datetime of last modification.
*
* @return DateTime Datetime of last modification.
*/
public function getLastModifiedDateTime();
/**
* Returns the order status history.
*
* @return OrderStatusHistoryListItemCollection Order status history.
*/
public function getStatusHistory();
/**
* Returns the order comment.
*
* @return string Order comment.
*/
public function getComment();
/**
* Returns the order addon key value from collection.
*
* @param StringType $key Addon key.
*
* @return string Addon value.
*/
public function getAddonValue(StringType $key);
/**
* Returns the order addon value collection.
*
* @return EditableKeyValueCollection Order addon value collection.
*/
public function getAddonValues();
/**
* Sets the order ID.
*
* @param IdType $id Order ID.
*
* @return OrderInterface Same instance for method chaining.
*/
public function setOrderId(IdType $id);
/**
* Sets the unique order hash.
*
* @param NonEmptyStringType $orderHash Unique order hash.
*
* @return GXEngineOrder Same instance for method chaining.
*/
public function setOrderHash(NonEmptyStringType $orderHash);
/**
* Sets the associated customer ID.
*
* @param IdType $id Customer ID.
*
* @return OrderInterface Same instance for method chaining.
*/
public function setCustomerId(IdType $id);
/**
* Sets the customer email address.
*
* @param EmailStringType $email Customer email address.
*
* @return OrderInterface Same instance for method chaining.
*/
public function setCustomerEmail(EmailStringType $email);
/**
* Sets the customer telephone number.
*
* @param StringType $telephone Customer telephone number.
*
* @return OrderInterface Same instance for method chaining.
*/
public function setCustomerTelephone(StringType $telephone);
/**
* Sets the order status ID.
*
* @param IntType $id Status ID.
*
* @return OrderInterface Same instance for method chaining.
*/
public function setStatusId(IntType $id);
/**
* Sets the customer address.
*
* @param AddressBlockInterface $address Customer address.
*
* @return OrderInterface Same instance for method chaining.
*/
public function setCustomerAddress(AddressBlockInterface $address);
/**
* Sets the billing address.
*
* @param AddressBlockInterface $address Billing address.
*
* @return OrderInterface Same instance for method chaining.
*/
public function setBillingAddress(AddressBlockInterface $address);
/**
* Sets the delivery address.
*
* @param AddressBlockInterface $address Delivery address.
*
* @return OrderInterface Same instance for method chaining.
*/
public function setDeliveryAddress(AddressBlockInterface $address);
/**
* Sets the order items collection.
*
* @param OrderItemCollection $collection Items collection.
*
* @return OrderInterface Same instance for method chaining.
*/
public function setOrderItems(OrderItemCollection $collection);
/**
* Sets the order total collection.
*
* @param OrderTotalCollection $collection Total collection.
*
* @return OrderInterface Same instance for method chaining.
*/
public function setOrderTotals(OrderTotalCollection $collection);
/**
* Sets the order shipping type.
*
* @param OrderShippingType $shippingType Shipping type.
*
* @return OrderInterface Same instance for method chaining.
*/
public function setShippingType(OrderShippingType $shippingType);
/**
* Sets the order payment type.
*
* @param OrderPaymentType $paymentType Payment type.
*
* @return OrderInterface Same instance for method chaining.
*/
public function setPaymentType(OrderPaymentType $paymentType);
/**
* Sets the order currency code.
*
* @param CurrencyCode $currencyCode Currency code.
*
* @return OrderInterface Same instance for method chaining.
*/
public function setCurrencyCode(CurrencyCode $currencyCode);
/**
* Sets the order language code.
*
* @param LanguageCode $languageCode Language code.
*
* @return OrderInterface Same instance for method chaining.
*/
public function setLanguageCode(LanguageCode $languageCode);
/**
* Sets the order purchase date time.
*
* @param DateTime $dateTime Purchase date time.
*
* @return OrderInterface Same instance for method chaining.
*/
public function setPurchaseDateTime(DateTime $dateTime);
/**
* Sets the date time of last modification.
*
* @param DateTime $lastModifiedDateTime Last modification date time
*
* @return OrderInterface Same instance for method chaining.
*/
public function setLastModifiedDateTime(DateTime $lastModifiedDateTime);
/**
* Sets the order comment.
*
* @param StringType $comment Comment.
*
* @return OrderInterface Same instance for method chaining.
*/
public function setComment(StringType $comment);
/**
* Returns the total weight of the ordered products.
*
* @return double
*/
public function getTotalWeight();
/**
* Sets the total weight of the ordered products.
*
* @param \DecimalType $totalWeight
*
* @return $this|OrderInterface Same instance for method chaining.
*/
public function setTotalWeight(DecimalType $totalWeight);
/**
* Adds/updates a key value in the addon value collection.
*
* @param StringType $key Addon key.
* @param StringType $value Addon value.
*
* @return OrderInterface Same instance for method chaining.
*/
public function setAddonValue(StringType $key, StringType $value);
/**
* Adds an addon collection to the existing one.
*
* @param KeyValueCollection $addonCollection Addon collection.
*
* @return OrderInterface Same instance for method chaining.
*/
public function addAddonValues(KeyValueCollection $addonCollection);
}