class DeliveryNote extends DataModel

A delivery note created for shipment.

Properties

protected array $fields from DataModel
protected boolean $isEncrypted from DataModel
protected Identity $customerOrderId
protected Identity $id
protected DateTime $creationDate
protected boolean $isFulfillment
protected string $note
protected DeliveryNoteItem[] $items
protected DeliveryNoteTrackingList[] $trackingLists

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
setCustomerOrderId(Identity $customerOrderId)

No description

getCustomerOrderId()

No description

setId(Identity $id)

No description

getId()

No description

setCreationDate(DateTime $creationDate = null)

No description

getCreationDate()

No description

setIsFulfillment(boolean $isFulfillment)

No description

boolean
getIsFulfillment()

No description

setNote(string $note)

No description

string
getNote()

No description

addItem(DeliveryNoteItem $item)

No description

setItems(array $items)

No description

getItems()

No description

clearItems()

No description

addTrackingList(DeliveryNoteTrackingList $trackingList)

No description

setTrackingLists(array $trackingLists)

No description

clearTrackingLists()

No description

Details

at line 83
__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 94
DeliveryNote setCustomerOrderId(Identity $customerOrderId)

Parameters

Identity $customerOrderId Reference to customerOrder

Return Value

DeliveryNote

Exceptions

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

at line 102
Identity getCustomerOrderId()

Return Value

Identity Reference to customerOrder

at line 112
DeliveryNote setId(Identity $id)

Parameters

Identity $id Unique deliveryNote id

Return Value

DeliveryNote

Exceptions

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

at line 120
Identity getId()

Return Value

Identity Unique deliveryNote id

at line 130
DeliveryNote setCreationDate(DateTime $creationDate = null)

Parameters

DateTime $creationDate Creation date

Return Value

DeliveryNote

Exceptions

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

at line 138
DateTime getCreationDate()

Return Value

DateTime Creation date

at line 147
DeliveryNote setIsFulfillment(boolean $isFulfillment)

Parameters

boolean $isFulfillment Optional flag for fulfillment. True, if delivery ist fulfilled by someone else

Return Value

DeliveryNote

at line 155
boolean getIsFulfillment()

Return Value

boolean Optional flag for fulfillment. True, if delivery ist fulfilled by someone else

at line 164
DeliveryNote setNote(string $note)

Parameters

string $note Optional text note

Return Value

DeliveryNote

at line 172
string getNote()

Return Value

string Optional text note

at line 181
DeliveryNote addItem(DeliveryNoteItem $item)

Parameters

DeliveryNoteItem $item

Return Value

DeliveryNote

at line 191
DeliveryNote setItems(array $items)

Parameters

array $items

Return Value

DeliveryNote

at line 200
DeliveryNoteItem[] getItems()

Return Value

DeliveryNoteItem[]

at line 208
DeliveryNote clearItems()

Return Value

DeliveryNote

at line 218
DeliveryNote addTrackingList(DeliveryNoteTrackingList $trackingList)

Parameters

DeliveryNoteTrackingList $trackingList

Return Value

DeliveryNote

at line 228
DeliveryNote setTrackingLists(array $trackingLists)

Parameters

array $trackingLists

Return Value

DeliveryNote

at line 237
DeliveryNoteTrackingList[] getTrackingLists()

Return Value

DeliveryNoteTrackingList[]

at line 245
DeliveryNote clearTrackingLists()

Return Value

DeliveryNote