Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "WhseDeliveryDocumentAddress" 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
    • WhseDeliveryDocumentAddress

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 additionalStreetPrefixName

additionalStreetPrefixName: undefined | string

Street 3. Additional address field which is printed above the Street line. The Street address contains two lines above the street and two lines below the street.See Print the Street address. Maximum length: 40.

nullable

Optional additionalStreetSuffixName

additionalStreetSuffixName: undefined | string

Street 5. Additional address field which is printed under the Street line. The Street address has two lines above the street and two lines below the steet.See Print the Street address. Maximum length: 40.

nullable

Optional businessPartnerName1

businessPartnerName1: undefined | string

Name 1. Address component: Name of an address. Maximum length: 40.

nullable

Optional businessPartnerName2

businessPartnerName2: undefined | string

Name 2. Maximum length: 40.

nullable

businessPartnerRole

businessPartnerRole: string

Partner Role. Describes the role or function of a partner in the business process. A partner role always refers to a certain role category.Possible partner roles include supplier, shipping office, goods recipient, and warehouse. Maximum length: 6.

Optional cityName

cityName: undefined | string

City. City name as part of the address. The city name is saved redundantly in another database field in upper- case letters, for search help.If the Postal regional structure ('city file') is active, the city name is checked against the Cities defined in the regional structure. Maximum length: 40.

nullable

Optional country

country: undefined | string

Country Key. The country key contains information which the system uses to check entries such as the length of the postal code or bank account number. The two-character ISO code in accordance with ISO 3166, which is delivered by SAP as a default, is usually used.It could also be the vehicle license plate country-code or a typical country key, for example, in Germany the Federal statistics office key.The country keys are determined at system installation in the global settings.The definition of the country key in the SAP system does not have to match political or government entities.Since the country key does not have to correspond to the ISO code in all installations, programs that differ according to certain values of the country key cannot query the country key T005-LAND1, but have to program based on the ISO code T005 INTCA. Maximum length: 3.

nullable

Optional emailAddress

emailAddress: undefined | string

Email Address. Internet mail address, also called e-mail address. Example: user.name@company.comThe Internet mail address is used to send mail via the Internet world-wide; the protocol used is SMTP (Simple Mail Transfer Protocol).The Internet mail address format is specified in various RFCs (Internet Request for Comment), including RFCs 821 and 822.This is not an IP address (192.56.30.6). Maximum length: 241.

nullable

Optional houseNumber

houseNumber: undefined | string

House Number. House number as part of an address. It is printed in the Street line.Other supplementary street information can be entered in the House number supplement or one of the Street2, Street3, Street4 or Street5 fields. See Print the Street address.A house number (e.g. 117) or a house number with supplement (e.g. 117a), or a house number range (e.g. 16-20), can be maintained in this field. Maximum length: 10.

nullable

outboundDeliveryOrder

outboundDeliveryOrder: string

Document Number. Maximum length: 35.

outboundDeliveryOrderItem

outboundDeliveryOrderItem: string

Item Number. Maximum length: 10.

Optional phoneNumber

phoneNumber: undefined | string

First telephone no.: dialling code+number. Telephone numbmer, consisting of dialing code and number, but without the country code. If the telephone number consists of a company number and an extension, the extension must be entered in the field extension.Telephone number, as it must be dialed from within the country. Maximum length: 30.

nullable

Optional postalCode

postalCode: undefined | string

City Postal Code. Postal code as part of the address If different postal codes are maintained for the PO Box and Street address of an address, this field contains the Street address postal code. Maximum length: 10.

nullable

Optional region

region: undefined | string

Region (State, Province, County). In some countries, the region forms part of the address. The meaning depends on the country. The automatic address formatting function prints the region in addresses in the USA, Canada, Italy, Brazil or Australia, and the county in Great Britain.For more information, see the examples in the documentation on the Address Layout Key.Meaning of the regional code in ...Australia -> ProvinceBrazil -> StateCanada -> ProvinceGermany -> StateGreat Britain -> CountyItaly -> ProvinceJapan -> PrefectureSwitzerland -> CantonUSA -> State. Maximum length: 3.

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 streetName

streetName: undefined | string

Street. Street name as part of the address. The street name is saved, redundantly in upper case in another database field, for search help purposes.There are other fields for address parts which can be printed above or below the street. See Print the Street address.The house number and other supplements are usually maintained in their own fields. See Formatting the Street line. Maximum length: 60.

nullable

Optional streetPrefixName

streetPrefixName: undefined | string

Street 2. Additional address field which is printed above the Street line. The Street address contains two lines above the street and two lines below the street.See Print the Street address.This field is not always automatically printed, as it was subsequently added to the address structure.The print program or form may need to be adjusted.This exception applies to the following fields:Street2, Street3, Street4, Street5, c/o name, and to all address fields added after Release 4.5. Maximum length: 40.

nullable

Optional streetSuffixName

streetSuffixName: undefined | string

Street 4. Additional address field which is printed below the Street line. The Street address contains two lines above the street and two lines below the street.See Print the Street address. Maximum length: 40.

nullable

toWhseOutboundDeliveryOrderHead

toWhseOutboundDeliveryOrderHead: WhseOutboundDeliveryOrderHead

One-to-one navigation property to the WhseOutboundDeliveryOrderHead entity.

toWhseOutboundDeliveryOrderItem

toWhseOutboundDeliveryOrderItem: WhseOutboundDeliveryOrderItem

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

Static ADDITIONAL_STREET_PREFIX_NAME

ADDITIONAL_STREET_PREFIX_NAME: StringField<WhseDeliveryDocumentAddress> = new StringField('AdditionalStreetPrefixName', WhseDeliveryDocumentAddress, 'Edm.String')

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

Static ADDITIONAL_STREET_SUFFIX_NAME

ADDITIONAL_STREET_SUFFIX_NAME: StringField<WhseDeliveryDocumentAddress> = new StringField('AdditionalStreetSuffixName', WhseDeliveryDocumentAddress, 'Edm.String')

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

Static ALL_FIELDS

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

All fields selector.

Static BUSINESS_PARTNER_NAME_1

BUSINESS_PARTNER_NAME_1: StringField<WhseDeliveryDocumentAddress> = new StringField('BusinessPartnerName1', WhseDeliveryDocumentAddress, 'Edm.String')

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

Static BUSINESS_PARTNER_NAME_2

BUSINESS_PARTNER_NAME_2: StringField<WhseDeliveryDocumentAddress> = new StringField('BusinessPartnerName2', WhseDeliveryDocumentAddress, 'Edm.String')

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

Static BUSINESS_PARTNER_ROLE

BUSINESS_PARTNER_ROLE: StringField<WhseDeliveryDocumentAddress> = new StringField('BusinessPartnerRole', WhseDeliveryDocumentAddress, 'Edm.String')

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

Static CITY_NAME

CITY_NAME: StringField<WhseDeliveryDocumentAddress> = new StringField('CityName', WhseDeliveryDocumentAddress, 'Edm.String')

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

Static COUNTRY

COUNTRY: StringField<WhseDeliveryDocumentAddress> = new StringField('Country', WhseDeliveryDocumentAddress, 'Edm.String')

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

Static EMAIL_ADDRESS

EMAIL_ADDRESS: StringField<WhseDeliveryDocumentAddress> = new StringField('EmailAddress', WhseDeliveryDocumentAddress, 'Edm.String')

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

Static HOUSE_NUMBER

HOUSE_NUMBER: StringField<WhseDeliveryDocumentAddress> = new StringField('HouseNumber', WhseDeliveryDocumentAddress, 'Edm.String')

Static representation of the houseNumber 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<WhseDeliveryDocumentAddress> = new StringField('OutboundDeliveryOrder', WhseDeliveryDocumentAddress, '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 OUTBOUND_DELIVERY_ORDER_ITEM

OUTBOUND_DELIVERY_ORDER_ITEM: StringField<WhseDeliveryDocumentAddress> = new StringField('OutboundDeliveryOrderItem', WhseDeliveryDocumentAddress, 'Edm.String')

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

Static PHONE_NUMBER

PHONE_NUMBER: StringField<WhseDeliveryDocumentAddress> = new StringField('PhoneNumber', WhseDeliveryDocumentAddress, 'Edm.String')

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

Static POSTAL_CODE

POSTAL_CODE: StringField<WhseDeliveryDocumentAddress> = new StringField('PostalCode', WhseDeliveryDocumentAddress, 'Edm.String')

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

Static REGION

REGION: StringField<WhseDeliveryDocumentAddress> = new StringField('Region', WhseDeliveryDocumentAddress, 'Edm.String')

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

Static STREET_NAME

STREET_NAME: StringField<WhseDeliveryDocumentAddress> = new StringField('StreetName', WhseDeliveryDocumentAddress, 'Edm.String')

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

Static STREET_PREFIX_NAME

STREET_PREFIX_NAME: StringField<WhseDeliveryDocumentAddress> = new StringField('StreetPrefixName', WhseDeliveryDocumentAddress, 'Edm.String')

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

Static STREET_SUFFIX_NAME

STREET_SUFFIX_NAME: StringField<WhseDeliveryDocumentAddress> = new StringField('StreetSuffixName', WhseDeliveryDocumentAddress, 'Edm.String')

Static representation of the streetSuffixName property 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_HEAD

TO_WHSE_OUTBOUND_DELIVERY_ORDER_HEAD: OneToOneLink<WhseDeliveryDocumentAddress, WhseOutboundDeliveryOrderHead> = new OneToOneLink('to_WhseOutboundDeliveryOrderHead', WhseDeliveryDocumentAddress, WhseOutboundDeliveryOrderHead)

Static representation of the one-to-one navigation property toWhseOutboundDeliveryOrderHead 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: OneToOneLink<WhseDeliveryDocumentAddress, WhseOutboundDeliveryOrderItem> = new OneToOneLink('to_WhseOutboundDeliveryOrderItem', WhseDeliveryDocumentAddress, WhseOutboundDeliveryOrderItem)

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

Static _allFields

_allFields: Array<StringField<WhseDeliveryDocumentAddress> | OneToOneLink<WhseDeliveryDocumentAddress, WhseOutboundDeliveryOrderHead> | OneToOneLink<WhseDeliveryDocumentAddress, WhseOutboundDeliveryOrderItem>> = [WhseDeliveryDocumentAddress.OUTBOUND_DELIVERY_ORDER,WhseDeliveryDocumentAddress.OUTBOUND_DELIVERY_ORDER_ITEM,WhseDeliveryDocumentAddress.BUSINESS_PARTNER_ROLE,WhseDeliveryDocumentAddress.BUSINESS_PARTNER_NAME_1,WhseDeliveryDocumentAddress.BUSINESS_PARTNER_NAME_2,WhseDeliveryDocumentAddress.STREET_PREFIX_NAME,WhseDeliveryDocumentAddress.ADDITIONAL_STREET_PREFIX_NAME,WhseDeliveryDocumentAddress.STREET_NAME,WhseDeliveryDocumentAddress.STREET_SUFFIX_NAME,WhseDeliveryDocumentAddress.ADDITIONAL_STREET_SUFFIX_NAME,WhseDeliveryDocumentAddress.HOUSE_NUMBER,WhseDeliveryDocumentAddress.POSTAL_CODE,WhseDeliveryDocumentAddress.CITY_NAME,WhseDeliveryDocumentAddress.REGION,WhseDeliveryDocumentAddress.COUNTRY,WhseDeliveryDocumentAddress.PHONE_NUMBER,WhseDeliveryDocumentAddress.EMAIL_ADDRESS,WhseDeliveryDocumentAddress.TO_WHSE_OUTBOUND_DELIVERY_ORDER_HEAD,WhseDeliveryDocumentAddress.TO_WHSE_OUTBOUND_DELIVERY_ORDER_ITEM]

All fields of the WhseDeliveryDocumentAddress 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 = "WhseDeliveryDocumentAddress"

Technical entity name for WhseDeliveryDocumentAddress.

Static _keyFields

_keyFields: Array<Selectable<WhseDeliveryDocumentAddress>> = [WhseDeliveryDocumentAddress.OUTBOUND_DELIVERY_ORDER, WhseDeliveryDocumentAddress.OUTBOUND_DELIVERY_ORDER_ITEM, WhseDeliveryDocumentAddress.BUSINESS_PARTNER_ROLE]

All key fields of the WhseDeliveryDocumentAddress entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "cds_api_whse_outb_delivery_order"
deprecated

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

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 WhseDeliveryDocumentAddress.

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<WhseDeliveryDocumentAddress>

    A builder that constructs instances of entity type WhseDeliveryDocumentAddress.

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 WhseDeliveryDocumentAddress entity type.

    Returns WhseDeliveryDocumentAddressRequestBuilder

    A WhseDeliveryDocumentAddress request builder.