Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "WhseOutboundDeliveryOrderHead" of service "cds_api_whse_outb_delivery_order". This service is part of the following communication scenarios: Warehousing - Process Outbound Delivery Order Integration (SAP_COM_0356). See https://api.sap.com/api/API_WHSE_OUTB_DLV_ORDER for more information.

Hierarchy

  • Entity
    • WhseOutboundDeliveryOrderHead

Implements

Index

Constructors

constructor

Properties

Protected _customFields

_customFields: MapType<any>

A mapper representing custom fields in an entity. Custom fields are represented by their field names and the corresponding values. A custom field can be added or updated using setCustomField method.

Protected _versionIdentifier

_versionIdentifier: string

The current ETag version of the entity in the remote system. The ETag identified the version of the in the remote system. It will be automatically set in the "if-match" header of update requests and can be set as a custom header for delete requests. When no ETag is provided by the remote system the value of this variable defaults to "*".

Optional carrier

carrier: undefined | string

Business Partner Number. Key identifying a business partner in the SAP system. The key is unique within a client. Maximum length: 10.

nullable

Optional carrierName

carrierName: undefined | string

Name 1 of organization. First name field for business partners in the Organization category. Maximum length: 40.

nullable

Optional deliveryCategory

deliveryCategory: undefined | string

Document Category. Maximum length: 3.

nullable

Optional deliveryType

deliveryType: undefined | string

Document Type. In connection with the document category, the document type classifies the different documents in relation to the delivery process. Each document type is assigned to one or more document categories.The document type maps the delivery process in the system in combination with the item type. Maximum length: 4.

nullable

Optional incotermsPart1

incotermsPart1: undefined | string

Incoterms (Part 1). Maximum length: 3.

nullable

Optional incotermsPart2

incotermsPart2: undefined | string

Incoterms (Part 2). Maximum length: 28.

nullable

Optional lastChangeDateTime

lastChangeDateTime: Moment

UTC Time Stamp in Short Form (YYYYMMDDhhmmss). The UTC time stamp is the date and time relative to UTC (Universal Coordinated Time). To standardize local times in a UTC time stamp and thus make them comparable with other times, these local times need to be converted using your time zone and the ABAP command convert.Even if the system is able to determine the time zone from Customizing or master data, you shoul save the time zone redundantly here.The internal structure of the UTC time stamp is subdivided into a date part and a time part in packed number format <YYYYMMDDhhmmss>. You can also use the high resolution UTC time stamp (10^-7 seconds).

nullable

outboundDeliveryOrder

outboundDeliveryOrder: string

Document Number. Maximum length: 35.

Optional plannedDeliveryUtcDateTime

plannedDeliveryUtcDateTime: Moment

Creation Date/Time.

nullable

Optional plannedOutOfYardUtcDateTime

plannedOutOfYardUtcDateTime: Moment

Creation Date/Time.

nullable

Protected remoteState

remoteState: object

The remote state of the entity. Remote state refers to the last known state of the entity on the remote system from which it has been retrieved or to which it has been posted. It is stored as map, where the keys are stored in the format of VDM properties.

Type declaration

  • [keys: string]: any

Optional route

route: undefined | string

Route Name (Identification). Maximum length: 10.

nullable

Optional salesOrganization

salesOrganization: undefined | string

Sales Organization. An organizational unit responsible for the sale of certain products or services. The responsibility of a sales organization may include legal liability for products and customer claims. You can assign any number of distribution channels and divisions to a sales organization. A particular combination of sales organization, distribution channel, and division is known as a sales area. Maximum length: 4.

nullable

Optional shipToParty

shipToParty: undefined | string

Business Partner Number. Key identifying a business partner in the SAP system. The key is unique within a client. Maximum length: 10.

nullable

Optional shipToPartyName

shipToPartyName: undefined | string

Name 1 of organization. First name field for business partners in the Organization category. Maximum length: 40.

nullable

Optional shippingOffice

shippingOffice: undefined | string

Location Number. Maximum length: 20.

nullable

toShipToPartyDocumentAddress

toShipToPartyDocumentAddress: WhseDeliveryDocumentAddress[]

One-to-many navigation property to the WhseDeliveryDocumentAddress entity.

toWhseOutboundDeliveryOrderItem

toWhseOutboundDeliveryOrderItem: WhseOutboundDeliveryOrderItem[]

One-to-many navigation property to the WhseOutboundDeliveryOrderItem entity.

Optional warehouse

warehouse: undefined | string

Warehouse Number/Warehouse Complex. Alphanumeric key that identifies a complex, physical warehouse within the warehouse management system. All activities within a warehouse, for example, goods movements and physical inventory, are assigned to a specific warehouse number. The physical warehouse where these activities take place is identified by the warehouse number. Maximum length: 4.

nullable

Static ALL_FIELDS

ALL_FIELDS: AllFields<WhseOutboundDeliveryOrderHead> = new AllFields('*', WhseOutboundDeliveryOrderHead)

All fields selector.

Static CARRIER

CARRIER: StringField<WhseOutboundDeliveryOrderHead> = new StringField('Carrier', WhseOutboundDeliveryOrderHead, 'Edm.String')

Static representation of the carrier property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static CARRIER_NAME

CARRIER_NAME: StringField<WhseOutboundDeliveryOrderHead> = new StringField('CarrierName', WhseOutboundDeliveryOrderHead, 'Edm.String')

Static representation of the carrierName property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static DELIVERY_CATEGORY

DELIVERY_CATEGORY: StringField<WhseOutboundDeliveryOrderHead> = new StringField('DeliveryCategory', WhseOutboundDeliveryOrderHead, 'Edm.String')

Static representation of the deliveryCategory property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static DELIVERY_TYPE

DELIVERY_TYPE: StringField<WhseOutboundDeliveryOrderHead> = new StringField('DeliveryType', WhseOutboundDeliveryOrderHead, 'Edm.String')

Static representation of the deliveryType property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static INCOTERMS_PART_1

INCOTERMS_PART_1: StringField<WhseOutboundDeliveryOrderHead> = new StringField('IncotermsPart1', WhseOutboundDeliveryOrderHead, 'Edm.String')

Static representation of the incotermsPart1 property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static INCOTERMS_PART_2

INCOTERMS_PART_2: StringField<WhseOutboundDeliveryOrderHead> = new StringField('IncotermsPart2', WhseOutboundDeliveryOrderHead, 'Edm.String')

Static representation of the incotermsPart2 property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static LAST_CHANGE_DATE_TIME

LAST_CHANGE_DATE_TIME: DateField<WhseOutboundDeliveryOrderHead> = new DateField('LastChangeDateTime', WhseOutboundDeliveryOrderHead, 'Edm.DateTimeOffset')

Static representation of the lastChangeDateTime property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static OUTBOUND_DELIVERY_ORDER

OUTBOUND_DELIVERY_ORDER: StringField<WhseOutboundDeliveryOrderHead> = new StringField('OutboundDeliveryOrder', WhseOutboundDeliveryOrderHead, 'Edm.String')

Static representation of the outboundDeliveryOrder property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PLANNED_DELIVERY_UTC_DATE_TIME

PLANNED_DELIVERY_UTC_DATE_TIME: DateField<WhseOutboundDeliveryOrderHead> = new DateField('PlannedDeliveryUTCDateTime', WhseOutboundDeliveryOrderHead, 'Edm.DateTimeOffset')

Static representation of the plannedDeliveryUtcDateTime property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static PLANNED_OUT_OF_YARD_UTC_DATE_TIME

PLANNED_OUT_OF_YARD_UTC_DATE_TIME: DateField<WhseOutboundDeliveryOrderHead> = new DateField('PlannedOutOfYardUTCDateTime', WhseOutboundDeliveryOrderHead, 'Edm.DateTimeOffset')

Static representation of the plannedOutOfYardUtcDateTime property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static ROUTE

ROUTE: StringField<WhseOutboundDeliveryOrderHead> = new StringField('Route', WhseOutboundDeliveryOrderHead, 'Edm.String')

Static representation of the route property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static SALES_ORGANIZATION

SALES_ORGANIZATION: StringField<WhseOutboundDeliveryOrderHead> = new StringField('SalesOrganization', WhseOutboundDeliveryOrderHead, 'Edm.String')

Static representation of the salesOrganization property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static SHIPPING_OFFICE

SHIPPING_OFFICE: StringField<WhseOutboundDeliveryOrderHead> = new StringField('ShippingOffice', WhseOutboundDeliveryOrderHead, 'Edm.String')

Static representation of the shippingOffice property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static SHIP_TO_PARTY

SHIP_TO_PARTY: StringField<WhseOutboundDeliveryOrderHead> = new StringField('ShipToParty', WhseOutboundDeliveryOrderHead, 'Edm.String')

Static representation of the shipToParty property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static SHIP_TO_PARTY_NAME

SHIP_TO_PARTY_NAME: StringField<WhseOutboundDeliveryOrderHead> = new StringField('ShipToPartyName', WhseOutboundDeliveryOrderHead, 'Edm.String')

Static representation of the shipToPartyName property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_SHIP_TO_PARTY_DOCUMENT_ADDRESS

TO_SHIP_TO_PARTY_DOCUMENT_ADDRESS: Link<WhseOutboundDeliveryOrderHead, WhseDeliveryDocumentAddress> = new Link('to_ShipToPartyDocumentAddress', WhseOutboundDeliveryOrderHead, WhseDeliveryDocumentAddress)

Static representation of the one-to-many navigation property toShipToPartyDocumentAddress for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static TO_WHSE_OUTBOUND_DELIVERY_ORDER_ITEM

TO_WHSE_OUTBOUND_DELIVERY_ORDER_ITEM: Link<WhseOutboundDeliveryOrderHead, WhseOutboundDeliveryOrderItem> = new Link('to_WhseOutboundDeliveryOrderItem', WhseOutboundDeliveryOrderHead, WhseOutboundDeliveryOrderItem)

Static representation of the one-to-many navigation property toWhseOutboundDeliveryOrderItem for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static WAREHOUSE

WAREHOUSE: StringField<WhseOutboundDeliveryOrderHead> = new StringField('Warehouse', WhseOutboundDeliveryOrderHead, 'Edm.String')

Static representation of the warehouse property for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static _allFields

_allFields: Array<StringField<WhseOutboundDeliveryOrderHead> | DateField<WhseOutboundDeliveryOrderHead> | Link<WhseOutboundDeliveryOrderHead, WhseDeliveryDocumentAddress> | Link<WhseOutboundDeliveryOrderHead, WhseOutboundDeliveryOrderItem>> = [WhseOutboundDeliveryOrderHead.OUTBOUND_DELIVERY_ORDER,WhseOutboundDeliveryOrderHead.WAREHOUSE,WhseOutboundDeliveryOrderHead.DELIVERY_CATEGORY,WhseOutboundDeliveryOrderHead.DELIVERY_TYPE,WhseOutboundDeliveryOrderHead.SHIP_TO_PARTY,WhseOutboundDeliveryOrderHead.SHIP_TO_PARTY_NAME,WhseOutboundDeliveryOrderHead.CARRIER,WhseOutboundDeliveryOrderHead.CARRIER_NAME,WhseOutboundDeliveryOrderHead.PLANNED_DELIVERY_UTC_DATE_TIME,WhseOutboundDeliveryOrderHead.PLANNED_OUT_OF_YARD_UTC_DATE_TIME,WhseOutboundDeliveryOrderHead.INCOTERMS_PART_1,WhseOutboundDeliveryOrderHead.INCOTERMS_PART_2,WhseOutboundDeliveryOrderHead.ROUTE,WhseOutboundDeliveryOrderHead.SALES_ORGANIZATION,WhseOutboundDeliveryOrderHead.SHIPPING_OFFICE,WhseOutboundDeliveryOrderHead.LAST_CHANGE_DATE_TIME,WhseOutboundDeliveryOrderHead.TO_SHIP_TO_PARTY_DOCUMENT_ADDRESS,WhseOutboundDeliveryOrderHead.TO_WHSE_OUTBOUND_DELIVERY_ORDER_ITEM]

All fields of the WhseOutboundDeliveryOrderHead entity.

Static _defaultServicePath

_defaultServicePath: string = "/sap/opu/odata/sap/API_WHSE_OUTB_DLV_ORDER"

Default url path for the according service.

Static _entityName

_entityName: string = "WhseOutboundDeliveryOrderHead"

Technical entity name for WhseOutboundDeliveryOrderHead.

Static _keyFields

_keyFields: Array<Selectable<WhseOutboundDeliveryOrderHead>> = [WhseOutboundDeliveryOrderHead.OUTBOUND_DELIVERY_ORDER]

All key fields of the WhseOutboundDeliveryOrderHead entity.

Static _keys

_keys: object = WhseOutboundDeliveryOrderHead._keyFields.reduce((acc: { [keys: string]: Selectable<WhseOutboundDeliveryOrderHead> }, field: Selectable<WhseOutboundDeliveryOrderHead>) => {acc[field._fieldName] = field;return acc;}, {})

Mapping of all key field names to the respective static field property WhseOutboundDeliveryOrderHead.

Type declaration

Static _serviceName

_serviceName: string = "cds_api_whse_outb_delivery_order"
deprecated

Since v1.0.1 Use _defaultServicePath instead. Technical service name for WhseOutboundDeliveryOrderHead.

Accessors

versionIdentifier

  • get versionIdentifier(): string
  • ETag version identifier accessor.

    Returns string

    The ETag version identifier of the retrieved entity, returns undefined if not retrieved

Methods

Protected getCurrentMapKeys

  • getCurrentMapKeys(): Entity
  • Returns a map of all defined fields in entity to their current values.

    Returns Entity

    Entity with all defined entity fields

getCustomField

  • getCustomField(fieldName: string): any
  • Custom field value getter.

    Parameters

    • fieldName: string

      The name of the custom field

    Returns any

    The value of the corresponding custom field

getCustomFields

  • getCustomFields(): MapType<any>
  • Returns a map that contains all entity custom fields.

    Returns MapType<any>

    A map of all defined custom fields in the entity

getUpdatedCustomFields

  • getUpdatedCustomFields(): MapType<any>
  • Returns all updated custom field properties compared to the last known remote state.

    Returns MapType<any>

    A map containing all updated custom properties, with their new values

getUpdatedProperties

  • getUpdatedProperties(): Entity
  • Returns all changed properties compared to the last known remote state. The returned properties does not include custom fields. Use getUpdatedCustomFields, if updated custom fields are needed.

    Returns Entity

    Entity with all properties that changed

hasCustomField

  • hasCustomField(fieldName: string): boolean
  • Validates whether a custom field exists in the entity.

    Parameters

    • fieldName: string

      The name of the custom field to update

    Returns boolean

    A boolean value, that indicates whether a custom field is defined in entity

initializeCustomFields

  • initializeCustomFields(customFields: MapType<any>): this
  • Sets all retrieved custom fields in entity.

    Parameters

    • customFields: MapType<any>

      Extracted custom fields from a retrieved entity

    Returns this

    A boolean value, that indicates the existence of the field in entity

Protected isConflictingCustomField

  • isConflictingCustomField(customFieldName: string): boolean
  • Validates whether a field name does not conflict with an original field name and thus can be defined as custom fields.

    Parameters

    • customFieldName: string

      Field name to check

    Returns boolean

    Boolean value that describes whether a field name can be defined as custom field

setCustomField

  • setCustomField(fieldName: string, value: any): this
  • Sets a new custom field in the entity or updates it. Throws an error, if the provided custom field name is already defined by an original field in entity.

    Parameters

    • fieldName: string

      The name of the custom field to update

    • value: any

      The value of the field

    Returns this

    The entity itself, to facilitate method chaining

setOrInitializeRemoteState

  • setOrInitializeRemoteState(state?: MapType<any>): this
  • Initializes or sets the remoteState of the entity. This function is called on all read, create and update requests. This function should be called after initializeCustomFields, if custom fields are defined.

    deprecated

    Since 1.12.0. Will be removed in version 2.0.

    Parameters

    • Optional state: MapType<any>

      State to be set as remote state

    Returns this

    The entity itself, to facilitate method chaining

setVersionIdentifier

  • setVersionIdentifier(etag: string | undefined): this
  • Set the ETag version identifier of the retrieved entity.

    Parameters

    • etag: string | undefined

      The returned ETag version of the entity

    Returns this

    The entity itself, to facilitate method chaining

toJSON

  • toJSON(): object
  • Overwrites the default toJSON method so that all instance variables as well as all custom fields of the entity are returned.

    Returns object

    An object containing all instance variables + custom fields.

    • [key: string]: any

Static builder

Static customField

  • Returns a selectable object that allows the selection of custom field in a get request for the entity WhseOutboundDeliveryOrderHead.

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<WhseOutboundDeliveryOrderHead>

    A builder that constructs instances of entity type WhseOutboundDeliveryOrderHead.

Static Protected customFieldSelector

  • customFieldSelector<EntityT>(fieldName: string, entityConstructor: Constructable<EntityT>): CustomField<EntityT>
  • Type parameters

    • EntityT: Entity

    Parameters

    • fieldName: string
    • entityConstructor: Constructable<EntityT>

    Returns CustomField<EntityT>

Static Protected entityBuilder

  • entityBuilder<EntityT, EntityTypeForceMandatoryT>(entityConstructor: Constructable<EntityT, EntityTypeForceMandatoryT>): EntityBuilderType<EntityT, EntityTypeForceMandatoryT>
  • Type parameters

    • EntityT: Entity

    • EntityTypeForceMandatoryT

    Parameters

    • entityConstructor: Constructable<EntityT, EntityTypeForceMandatoryT>

    Returns EntityBuilderType<EntityT, EntityTypeForceMandatoryT>

Static requestBuilder

  • Returns a request builder to construct requests for operations on the WhseOutboundDeliveryOrderHead entity type.

    Returns WhseOutboundDeliveryOrderHeadRequestBuilder

    A WhseOutboundDeliveryOrderHead request builder.