class CustomerOrder extends DataModel

Customer order properties.

Constants

PAYMENT_STATUS_COMPLETED

PAYMENT_STATUS_PARTIALLY

PAYMENT_STATUS_UNPAID

STATUS_NEW

STATUS_CANCELLED

STATUS_PARTIALLY_SHIPPED

STATUS_SHIPPED

Properties

protected array $fields from DataModel
protected boolean $isEncrypted from DataModel
protected Identity $customerId
protected Identity $id
protected CustomerOrderBillingAddress $billingAddress
protected string $carrierName
protected DateTime $creationDate
protected string $currencyIso
protected DateTime $estimatedDeliveryDate
protected string $languageISO
protected string $note
protected string $orderNumber
protected DateTime $paymentDate
protected CustomerOrderPaymentInfo $paymentInfo
protected string $paymentModuleCode
protected string $paymentStatus
protected string $pui
protected CustomerOrderShippingAddress $shippingAddress
protected DateTime $shippingDate
protected string $shippingInfo
protected string $shippingMethodName
protected string $status
protected double $totalSum
protected double $totalSumGross
protected CustomerOrderAttr[] $attributes
protected CustomerOrderItem[] $items

Methods

__construct()

Constructor

multitype:
getProperties()

Get the Model Properties

from Model
setOptions(stdClass $object = null, array $options = null)

Sets Properties with matching Array Values

from DataModel
stdClass
getPublic(array $publics = array('fields', 'isEncrypted', 'identities', '_type'))

Convert the Model into stdClass Object

from DataModel
toJson()

No description

from Model
mixed:string
getFields()

Fields Getter

from DataModel
validate()

Object Validation

from DataModel
mixed:string|NULL
getField(boolean $toWawi = false, string $key)

Get a Model Member Name

from DataModel
map(boolean $toWawi = false, stdClass $obj = null)

Object Mapping

from DataModel
getModelType()

No description

from DataModel
boolean
isEncrypted()

Encrypted Status

from DataModel
setIdentity(string $propertyName, string|null $endpoint = null, int|null $host = null)

No description

from DataModel
setProperty($name, $value, $type)

No description

from DataModel
validateType($value, $type)

No description

from DataModel
setCustomerId(Identity $customerId)

No description

getCustomerId()

No description

setId(Identity $id)

No description

getId()

No description

setBillingAddress(CustomerOrderBillingAddress $billingAddress = null)

No description

setCarrierName(string $carrierName)

No description

string
getCarrierName()

No description

setCreationDate(DateTime $creationDate = null)

No description

getCreationDate()

No description

setCurrencyIso(string $currencyIso)

No description

string
getCurrencyIso()

No description

setEstimatedDeliveryDate(DateTime $estimatedDeliveryDate = null)

No description

setLanguageISO(string $languageISO)

No description

string
getLanguageISO()

No description

setNote(string $note)

No description

string
getNote()

No description

setOrderNumber(string $orderNumber)

No description

string
getOrderNumber()

No description

setPaymentDate(DateTime $paymentDate = null)

No description

getPaymentDate()

No description

setPaymentInfo(CustomerOrderPaymentInfo $paymentInfo = null)

No description

setPaymentModuleCode(string $paymentModuleCode)

No description

string
getPaymentModuleCode()

No description

setPaymentStatus(string $paymentStatus)

No description

string
getPaymentStatus()

No description

setPui(string $pui)

No description

string
getPui()

No description

setShippingAddress(CustomerOrderShippingAddress $shippingAddress = null)

No description

setShippingDate(DateTime $shippingDate = null)

No description

getShippingDate()

No description

setShippingInfo(string $shippingInfo)

No description

string
getShippingInfo()

No description

setShippingMethodName(string $shippingMethodName)

No description

string
getShippingMethodName()

No description

setStatus(string $status)

No description

string
getStatus()

No description

setTotalSum(double $totalSum)

No description

double
getTotalSum()

No description

setTotalSumGross(double $totalSumGross)

No description

double
getTotalSumGross()

No description

addAttribute(CustomerOrderAttr $attribute)

No description

setAttributes(array $attributes)

No description

getAttributes()

No description

clearAttributes()

No description

addItem(CustomerOrderItem $item)

No description

setItems(array $items)

No description

getItems()

No description

clearItems()

No description

Details

at line 254
__construct()

Constructor

in Model at line 33
multitype: getProperties()

Get the Model Properties

Return Value

multitype: string

in DataModel at line 172
Model setOptions(stdClass $object = null, array $options = null)

Sets Properties with matching Array Values

Parameters

stdClass $object
array $options

Return Value

Model

in DataModel at line 70
stdClass getPublic(array $publics = array('fields', 'isEncrypted', 'identities', '_type'))

Convert the Model into stdClass Object

Parameters

array $publics

Return Value

stdClass $object

in Model at line 115
toJson()

in DataModel at line 35
mixed:string getFields()

Fields Getter

Return Value

mixed:string

in DataModel at line 45
validate()

Object Validation

Exceptions

SchemaException

in DataModel at line 59
mixed:string|NULL getField(boolean $toWawi = false, string $key)

Get a Model Member Name

Parameters

boolean $toWawi
string $key

Return Value

mixed:string|NULL

in DataModel at line 81
map(boolean $toWawi = false, stdClass $obj = null)

Object Mapping

Parameters

boolean $toWawi
stdClass $obj Object to map

in DataModel at line 42
DataType getModelType()

Return Value

DataType

in DataModel at line 59
boolean isEncrypted()

Encrypted Status

Return Value

boolean

in DataModel at line 123
setIdentity(string $propertyName, string|null $endpoint = null, int|null $host = null)

Parameters

string $propertyName
string|null $endpoint
int|null $host

in DataModel at line 179
protected setProperty($name, $value, $type)

Parameters

$name
$value
$type

in DataModel at line 190
protected validateType($value, $type)

Parameters

$value
$type

at line 265
CustomerOrder setCustomerId(Identity $customerId)

Parameters

Identity $customerId Optional reference to customer.

Return Value

CustomerOrder

Exceptions

InvalidArgumentException if the provided argument is not of type 'Identity'.

at line 273
Identity getCustomerId()

Return Value

Identity Optional reference to customer.

at line 283
CustomerOrder setId(Identity $id)

Parameters

Identity $id Unique customerOrder id

Return Value

CustomerOrder

Exceptions

InvalidArgumentException if the provided argument is not of type 'Identity'.

at line 291
Identity getId()

Return Value

Identity Unique customerOrder id

at line 301
CustomerOrder setBillingAddress(CustomerOrderBillingAddress $billingAddress = null)

Parameters

CustomerOrderBillingAddress $billingAddress Billing address

Return Value

CustomerOrder

Exceptions

InvalidArgumentException if the provided argument is not of type 'CustomerOrderBillingAddress'.

at line 309
CustomerOrderBillingAddress getBillingAddress()

Return Value

CustomerOrderBillingAddress Billing address

at line 318
CustomerOrder setCarrierName(string $carrierName)

Parameters

string $carrierName

Return Value

CustomerOrder

at line 326
string getCarrierName()

Return Value

string

at line 336
CustomerOrder setCreationDate(DateTime $creationDate = null)

Parameters

DateTime $creationDate Date of creation

Return Value

CustomerOrder

Exceptions

InvalidArgumentException if the provided argument is not of type 'DateTime'.

at line 344
DateTime getCreationDate()

Return Value

DateTime Date of creation

at line 353
CustomerOrder setCurrencyIso(string $currencyIso)

Parameters

string $currencyIso

Return Value

CustomerOrder

at line 361
string getCurrencyIso()

Return Value

string

at line 371
CustomerOrder setEstimatedDeliveryDate(DateTime $estimatedDeliveryDate = null)

Parameters

DateTime $estimatedDeliveryDate

Return Value

CustomerOrder

Exceptions

InvalidArgumentException if the provided argument is not of type 'DateTime'.

at line 379
DateTime getEstimatedDeliveryDate()

Return Value

DateTime

at line 388
CustomerOrder setLanguageISO(string $languageISO)

Parameters

string $languageISO Locale set when customerOrder was finished. Important for further E-Mail message and notification localization.

Return Value

CustomerOrder

at line 396
string getLanguageISO()

Return Value

string Locale set when customerOrder was finished. Important for further E-Mail message and notification localization.

at line 405
CustomerOrder setNote(string $note)

Parameters

string $note

Return Value

CustomerOrder

at line 413
string getNote()

Return Value

string

at line 422
CustomerOrder setOrderNumber(string $orderNumber)

Parameters

string $orderNumber Optional order number (usually set by ERP System later)

Return Value

CustomerOrder

at line 430
string getOrderNumber()

Return Value

string Optional order number (usually set by ERP System later)

at line 440
CustomerOrder setPaymentDate(DateTime $paymentDate = null)

Parameters

DateTime $paymentDate Payment date

Return Value

CustomerOrder

Exceptions

InvalidArgumentException if the provided argument is not of type 'DateTime'.

at line 448
DateTime getPaymentDate()

Return Value

DateTime Payment date

at line 458
CustomerOrder setPaymentInfo(CustomerOrderPaymentInfo $paymentInfo = null)

Parameters

CustomerOrderPaymentInfo $paymentInfo

Return Value

CustomerOrder

Exceptions

InvalidArgumentException if the provided argument is not of type 'CustomerOrderPaymentInfo'.

at line 466
CustomerOrderPaymentInfo getPaymentInfo()

at line 475
CustomerOrder setPaymentModuleCode(string $paymentModuleCode)

Parameters

string $paymentModuleCode

Return Value

CustomerOrder

at line 483
string getPaymentModuleCode()

Return Value

string

at line 492
CustomerOrder setPaymentStatus(string $paymentStatus)

Parameters

string $paymentStatus

Return Value

CustomerOrder

at line 500
string getPaymentStatus()

Return Value

string

at line 509
CustomerOrder setPui(string $pui)

Parameters

string $pui

Return Value

CustomerOrder

at line 517
string getPui()

Return Value

string

at line 527
CustomerOrder setShippingAddress(CustomerOrderShippingAddress $shippingAddress = null)

Parameters

CustomerOrderShippingAddress $shippingAddress Shipping address

Return Value

CustomerOrder

Exceptions

InvalidArgumentException if the provided argument is not of type 'CustomerOrderShippingAddress'.

at line 535
CustomerOrderShippingAddress getShippingAddress()

Return Value

CustomerOrderShippingAddress Shipping address

at line 545
CustomerOrder setShippingDate(DateTime $shippingDate = null)

Parameters

DateTime $shippingDate Shipping date

Return Value

CustomerOrder

Exceptions

InvalidArgumentException if the provided argument is not of type 'DateTime'.

at line 553
DateTime getShippingDate()

Return Value

DateTime Shipping date

at line 562
CustomerOrder setShippingInfo(string $shippingInfo)

Parameters

string $shippingInfo Additional shipping info

Return Value

CustomerOrder

at line 570
string getShippingInfo()

Return Value

string Additional shipping info

at line 579
CustomerOrder setShippingMethodName(string $shippingMethodName)

Parameters

string $shippingMethodName

Return Value

CustomerOrder

at line 587
string getShippingMethodName()

Return Value

string

at line 596
CustomerOrder setStatus(string $status)

Parameters

string $status Shipping status

Return Value

CustomerOrder

at line 604
string getStatus()

Return Value

string Shipping status

at line 613
CustomerOrder setTotalSum(double $totalSum)

Parameters

double $totalSum

Return Value

CustomerOrder

at line 621
double getTotalSum()

Return Value

double

at line 630
CustomerOrder setTotalSumGross(double $totalSumGross)

Parameters

double $totalSumGross

Return Value

CustomerOrder

at line 638
double getTotalSumGross()

Return Value

double

at line 647
CustomerOrder addAttribute(CustomerOrderAttr $attribute)

Parameters

CustomerOrderAttr $attribute

Return Value

CustomerOrder

at line 657
CustomerOrder setAttributes(array $attributes)

Parameters

array $attributes

Return Value

CustomerOrder

at line 666
CustomerOrderAttr[] getAttributes()

Return Value

CustomerOrderAttr[]

at line 674
CustomerOrder clearAttributes()

Return Value

CustomerOrder

at line 684
CustomerOrder addItem(CustomerOrderItem $item)

Parameters

CustomerOrderItem $item

Return Value

CustomerOrder

at line 694
CustomerOrder setItems(array $items)

Parameters

array $items

Return Value

CustomerOrder

at line 703
CustomerOrderItem[] getItems()

Return Value

CustomerOrderItem[]

at line 711
CustomerOrder clearItems()

Return Value

CustomerOrder