class CustomerOrderShippingAddress extends DataModel

Shipping Address properties of a customer (order)

Properties

protected array $fields from DataModel
protected boolean $isEncrypted from DataModel
protected Identity $customerId
protected Identity $id
protected string $city
protected string $company
protected string $countryIso
protected string $deliveryInstruction
protected string $eMail
protected string $extraAddressLine
protected string $fax
protected string $firstName
protected string $lastName
protected string $mobile
protected string $phone
protected string $salutation
protected string $state
protected string $street
protected string $title
protected string $zipCode

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
getCustomerId()

No description

getId()

No description

setCity(string $city)

No description

string
getCity()

No description

setCompany(string $company)

No description

string
getCompany()

No description

setCountryIso(string $countryIso)

No description

string
getCountryIso()

No description

setDeliveryInstruction(string $deliveryInstruction)

No description

string
getDeliveryInstruction()

No description

setEMail(string $eMail)

No description

string
getEMail()

No description

setExtraAddressLine(string $extraAddressLine)

No description

string
getExtraAddressLine()

No description

setFax(string $fax)

No description

string
getFax()

No description

setFirstName(string $firstName)

No description

string
getFirstName()

No description

setLastName(string $lastName)

No description

string
getLastName()

No description

setMobile(string $mobile)

No description

string
getMobile()

No description

setPhone(string $phone)

No description

string
getPhone()

No description

setSalutation(string $salutation)

No description

string
getSalutation()

No description

setState(string $state)

No description

string
getState()

No description

setStreet(string $street)

No description

string
getStreet()

No description

setTitle(string $title)

No description

string
getTitle()

No description

setZipCode(string $zipCode)

No description

string
getZipCode()

No description

Details

at line 171
__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 182
CustomerOrderShippingAddress setCustomerId(Identity $customerId)

Parameters

Identity $customerId Reference to customer

Return Value

CustomerOrderShippingAddress

Exceptions

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

at line 190
Identity getCustomerId()

Return Value

Identity Reference to customer

at line 200
CustomerOrderShippingAddress setId(Identity $id)

Parameters

Identity $id Unique customerOrderShippingAddress id

Return Value

CustomerOrderShippingAddress

Exceptions

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

at line 208
Identity getId()

Return Value

Identity Unique customerOrderShippingAddress id

at line 217
CustomerOrderShippingAddress setCity(string $city)

Parameters

string $city City

Return Value

CustomerOrderShippingAddress

at line 225
string getCity()

Return Value

string City

at line 234
CustomerOrderShippingAddress setCompany(string $company)

Parameters

string $company Company name

Return Value

CustomerOrderShippingAddress

at line 242
string getCompany()

Return Value

string Company name

at line 251
CustomerOrderShippingAddress setCountryIso(string $countryIso)

Parameters

string $countryIso Country ISO 3166-2 (2 letter Uppercase)

Return Value

CustomerOrderShippingAddress

at line 259
string getCountryIso()

Return Value

string Country ISO 3166-2 (2 letter Uppercase)

at line 268
CustomerOrderShippingAddress setDeliveryInstruction(string $deliveryInstruction)

Parameters

string $deliveryInstruction Delivery instruction e.g. "c/o John Doe"

Return Value

CustomerOrderShippingAddress

at line 276
string getDeliveryInstruction()

Return Value

string Delivery instruction e.g. "c/o John Doe"

at line 285
CustomerOrderShippingAddress setEMail(string $eMail)

Parameters

string $eMail E-Mail address

Return Value

CustomerOrderShippingAddress

at line 293
string getEMail()

Return Value

string E-Mail address

at line 302
CustomerOrderShippingAddress setExtraAddressLine(string $extraAddressLine)

Parameters

string $extraAddressLine Extra address line e.g. 'Apartment 2.5'

Return Value

CustomerOrderShippingAddress

at line 310
string getExtraAddressLine()

Return Value

string Extra address line e.g. 'Apartment 2.5'

at line 319
CustomerOrderShippingAddress setFax(string $fax)

Parameters

string $fax Fax number

Return Value

CustomerOrderShippingAddress

at line 327
string getFax()

Return Value

string Fax number

at line 336
CustomerOrderShippingAddress setFirstName(string $firstName)

Parameters

string $firstName First name

Return Value

CustomerOrderShippingAddress

at line 344
string getFirstName()

Return Value

string First name

at line 353
CustomerOrderShippingAddress setLastName(string $lastName)

Parameters

string $lastName Last name

Return Value

CustomerOrderShippingAddress

at line 361
string getLastName()

Return Value

string Last name

at line 370
CustomerOrderShippingAddress setMobile(string $mobile)

Parameters

string $mobile Mobile phone number

Return Value

CustomerOrderShippingAddress

at line 378
string getMobile()

Return Value

string Mobile phone number

at line 387
CustomerOrderShippingAddress setPhone(string $phone)

Parameters

string $phone Phone number

Return Value

CustomerOrderShippingAddress

at line 395
string getPhone()

Return Value

string Phone number

at line 404
CustomerOrderShippingAddress setSalutation(string $salutation)

Parameters

string $salutation Salutation e.g. 'Mr.'

Return Value

CustomerOrderShippingAddress

at line 412
string getSalutation()

Return Value

string Salutation e.g. 'Mr.'

at line 421
CustomerOrderShippingAddress setState(string $state)

Parameters

string $state State

Return Value

CustomerOrderShippingAddress

at line 429
string getState()

Return Value

string State

at line 438
CustomerOrderShippingAddress setStreet(string $street)

Parameters

string $street Street + streetnumber

Return Value

CustomerOrderShippingAddress

at line 446
string getStreet()

Return Value

string Street + streetnumber

at line 455
CustomerOrderShippingAddress setTitle(string $title)

Parameters

string $title Title e.g. ("Prof. Dr.")

Return Value

CustomerOrderShippingAddress

at line 463
string getTitle()

Return Value

string Title e.g. ("Prof. Dr.")

at line 472
CustomerOrderShippingAddress setZipCode(string $zipCode)

Parameters

string $zipCode Zip / postal code

Return Value

CustomerOrderShippingAddress

at line 480
string getZipCode()

Return Value

string Zip / postal code