Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_PurCtrAddress" of service "API_PURCHASECONTRACT_PROCESS_SRV". This service is part of the following communication scenarios: Distributed Manufacturing Integration (SAP_COM_0077), Purchase Contract Integration (SAP_COM_0101). See https://api.sap.com/api/API_PURCHASECONTRACT_PROCESS_SRV for more information.

Hierarchy

  • Entity
    • PurCtrAddress

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns PurCtrAddress

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

addressId

addressId: string

Address Number. Internal key for identifying a Business Address Services address. For more information about the meaning and use of the address number and the Business Address Services concepts, see the function group SZA0 documentation. Maximum length: 10.

Optional addressTimeZone

addressTimeZone: undefined | string

Address time zone. Time zone as part of an address. The time zone is automatically determined by the system in address maintenance if time zone Customizing is maintained.It depends on the country and the region. (Region means state, province or county, depending on the country)The automatic determination is only made if there is no value in the time zone field. Maximum length: 6.

nullable

Optional building

building: undefined | string

Building (Number or Code). Number or abbreviation of a building in an address. This field is not used when the address is printed. The name of a building such as "Empire State Building", which is also to appear in the printout of the address, must be stored above or below the street in one of the fields Street2, Street3, Street4 or Street5, depending on its position. See Print the Street address. Maximum length: 20.

nullable

Optional careOfName

careOfName: undefined | string

c/o name. Part of the address (c/o = care of) if the recipient is different from the occupant and the names are not similar (e.g. subtenants). Put the country-specific code (e.g. c/o) in front of the name of the occupant. This is not automatically done in the print format, like the language-specific word "PO Box".John Smithc/o David BrownThis 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 cityCode

cityCode: undefined | string

City code for city/street file. Maximum length: 12.

nullable

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 companyPostalCode

companyPostalCode: undefined | string

Company Postal Code (for Large Customers). Postal code that is assigned directly to one company (= company postal code = major customer postal code). This field is used for countries where major companies are assigned their own postal code by the national post office.This postal code has to be entered in the field "Company Postal Code". Postal codes for group major customers, however, have to be entered in the field "PO Box Postal Code", since individual customers with a shared postal code for group major customers are differentiated by means of their PO box. Maximum length: 10.

nullable

Optional consigneeName3

consigneeName3: undefined | string

Name 3. Maximum length: 40.

nullable

Optional consigneeName4

consigneeName4: undefined | string

Name 4. Maximum length: 40.

nullable

Optional correspondenceLanguage

correspondenceLanguage: undefined | string

Language Key. The language key indicates

  • the language in which texts are displayed,- the language in which you enter texts,- the language in which the system prints texts. Maximum length: 2.
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 district

district: undefined | string

District. City or District supplement In some countries, this entry is appended with a hyphen to the city name by the automatic address formatting, other countries, it is output on a line of its own or (e.g. in the USA) not printed.See the examples in the Address Layout Key documentation. Maximum length: 40.

nullable

Optional faxNumber

faxNumber: undefined | string

Fax number: dialling code+number. Fax number, consisting of dialling code and number, but without country dialling code. If the fax number consists of a company number and an extension, the extension must be entered in the field extension.Fax number, as it is to be dialled from within the same country.Enter the following for the number "01234/567-0":Fax: 01234/567Extension: 0Enter the following for the number "01234/567-891":Fax: 01234/567Extension: 891For the number "012-345-678" (678 as extension) enter the following:Fax: 012-345Extension: 678In the following cases, enter the complete number (without country dialing code) in the field Fax:No part of the number can be considered as an extension.You are not sure which part of the number can be considered as an extension. Maximum length: 30.

nullable

Optional floor

floor: undefined | string

Floor in building. Floor of the building as more exact specification of an address. This field is not printed in the address.Floors which should be printed must be in the field house number supplement or in one of the fields Street2, Street3, Street4 or Street5 depending on the desired position. See Print the Street address. Maximum length: 10.

nullable

Optional formOfAddress

formOfAddress: undefined | string

Form-of-Address Key. Key for form of address text. You can also define a form of address text in Customizing.The form of address text can be maintained in different languages. Maximum length: 4.

nullable

Optional fullName

fullName: undefined | string

Full name of a party (Bus. Partner, Org. Unit, Doc. address). This field contains the full name or formatted name of a party. For organizations or document addresses, typically the fields Name1 and Name2 are concatenated.For persons the field contains the formatted name according to country specific rules. It corresponds e.g. to the content of the fields BUT000-NAME1_TEXT or ADRP-NAME_TEXT. Maximum length: 80.

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

Optional houseNumberSupplementText

houseNumberSupplementText: undefined | string

House number supplement. House number supplement as part of an address, e.g. App. 17 orSuite 600.It is printed in the Street line.Further Street supplements can be put in one of the fields Street2, Street3, Street4 or Street5.See Print the Street address. Maximum length: 10.

nullable

Optional phoneNumber

phoneNumber: undefined | string

Telephone no.: dialling code+number. Telephone number, consisting of dialling code and number, but without country dialling 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 is dialled from within the country.For the number "01234/567-0" enter the following:Telephone: 01234/567Estension: 0For the number "01234/567-891" enter the following:Telephone: 01234/567Extension: 891For the number "012-345-678" (678 as extension) enter the following:Telepone: 012-345Extension: 678In the following cases enter the complete number (without country dialling code) in the field Telephone:No part of the number can be regarded as an extension.You are not sure which part of the number can be regarded as an extension. Maximum length: 30.

nullable

Optional poBox

poBox: undefined | string

PO Box. PO Box number as part of an address. Only enter the PO Box number in this field. The text "PO Box" is provided in the recipient language by the system when you print the address.When you print an address, the "Street address" and the "PO Box address" are distinguished. The print program determines which of them has priority if both are maintained in an address record.Besides the PO Box number, the PO Box address uses the following fields:PO Box postal code, if specified (otherwise the normal postal code)PO Box city, if specified (otherwise the normal city)PO Box region, if specified (otherwise the normal region)PO Box country, if specified (otherwise the normal country)If the address is a "PO Box" (without a number), do not fill the "PO Box" field. Select the "PO Box w/o Number" indicator instead.You can also enter a company postal code for organizational addresses, instead of a PO Box. A separate field is predefined for this entry.For general information and examples about address formatting, see the documentation on the Address Structure Key. Maximum length: 10.

nullable

Optional poBoxDeviatingCityName

poBoxDeviatingCityName: undefined | string

PO Box city. Different city for the PO Box as an address component. The PO Box city can be entered here if it is different from the address city.If the address is only a PO Box address, enter the city in the normal city field.If the address contains two different city names for the address and the PO Box address, use this field. Maximum length: 40.

nullable

Optional poBoxPostalCode

poBoxPostalCode: undefined | string

PO Box Postal Code. Postal code that is required for a unique assignment of the PO box. This field is used for countries where a different postal code applies to mail that is sent to the PO box rather than to the street address of a particular business partner.Postal codes for group major customers also have to be entered in the field for the PO box postal code since individual customers with a shared postal code for group major customers are differentiated by means of the PO box. Postal codes for major customers (= company postal codes), however, are assigned to one customer only and have to be entered in the field 'Company Postal Code'. Maximum length: 10.

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 prfrdCommMediumType

prfrdCommMediumType: undefined | string

Communication Method (Key) (Business Address Services). Communication method with which you can exchange documents and messages with a business partner. In Business Address Services, you can specify a standard communication method that can be used by programs to determine the means of communication for sending messages.One business partner wants all messages by fax, another by e-mail.The application context can restrict the possible methods of communication. For example, invitations should perhaps only be sent by post because of enclosures, whereas minutes can be sent by post, fax or e-mail.Communication strategies can be defined for this purpose and applied in application contexts. Maximum length: 3.

nullable

purchaseContract

purchaseContract: string

Purchasing Contract Header. Maximum length: 10.

purchaseContractItem

purchaseContractItem: string

Item Number of Purchasing Contract. Maximum length: 5.

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 roomNumber

roomNumber: undefined | string

Room or Apartment Number. Appartment or room number in an a ddress. This field is not printed.Entries which are to be printed must in the house number supplement field or in one of the Street2, Street3, Street4 or Street5 fields, depending on the desired position. See Print the Street address. Maximum length: 10.

nullable

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

Optional taxJurisdiction

taxJurisdiction: undefined | string

Tax Jurisdiction. Specifies the tax jurisdiction. Maximum length: 15.

nullable

Optional transportZone

transportZone: undefined | string

Transportation zone to or from which the goods are delivered. Sales and distribution: Regional zone of Goods recipient.Purchasing:Regional zone of supplier.You can define regional zones to suit the requirements of your own business and country.Sales and distributionthe system automatically proposes a suitable route by using the transportation zone of the goods recipient in combination with other information about the delivery, such as theCountries of origin and destinationShipping conditionsTransportation groupIn the USA, for example, you can define regional zones to correspond to the US postal zip codes. Maximum length: 10.

nullable

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

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

Static ADDITIONAL_STREET_PREFIX_NAME

ADDITIONAL_STREET_PREFIX_NAME: StringField<PurCtrAddress> = new StringField('AdditionalStreetPrefixName', PurCtrAddress, '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<PurCtrAddress> = new StringField('AdditionalStreetSuffixName', PurCtrAddress, '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 ADDRESS_ID

ADDRESS_ID: StringField<PurCtrAddress> = new StringField('AddressID', PurCtrAddress, 'Edm.String')

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

Static ADDRESS_TIME_ZONE

ADDRESS_TIME_ZONE: StringField<PurCtrAddress> = new StringField('AddressTimeZone', PurCtrAddress, 'Edm.String')

Static representation of the addressTimeZone 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<PurCtrAddress> = new AllFields('*', PurCtrAddress)

All fields selector.

Static BUILDING

BUILDING: StringField<PurCtrAddress> = new StringField('Building', PurCtrAddress, 'Edm.String')

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

Static CARE_OF_NAME

CARE_OF_NAME: StringField<PurCtrAddress> = new StringField('CareOfName', PurCtrAddress, 'Edm.String')

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

Static CITY_CODE

CITY_CODE: StringField<PurCtrAddress> = new StringField('CityCode', PurCtrAddress, 'Edm.String')

Static representation of the cityCode 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<PurCtrAddress> = new StringField('CityName', PurCtrAddress, '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 COMPANY_POSTAL_CODE

COMPANY_POSTAL_CODE: StringField<PurCtrAddress> = new StringField('CompanyPostalCode', PurCtrAddress, 'Edm.String')

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

Static CONSIGNEE_NAME_3

CONSIGNEE_NAME_3: StringField<PurCtrAddress> = new StringField('ConsigneeName3', PurCtrAddress, 'Edm.String')

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

Static CONSIGNEE_NAME_4

CONSIGNEE_NAME_4: StringField<PurCtrAddress> = new StringField('ConsigneeName4', PurCtrAddress, 'Edm.String')

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

Static CORRESPONDENCE_LANGUAGE

CORRESPONDENCE_LANGUAGE: StringField<PurCtrAddress> = new StringField('CorrespondenceLanguage', PurCtrAddress, 'Edm.String')

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

Static COUNTRY

COUNTRY: StringField<PurCtrAddress> = new StringField('Country', PurCtrAddress, '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 DISTRICT

DISTRICT: StringField<PurCtrAddress> = new StringField('District', PurCtrAddress, 'Edm.String')

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

Static FAX_NUMBER

FAX_NUMBER: StringField<PurCtrAddress> = new StringField('FaxNumber', PurCtrAddress, 'Edm.String')

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

Static FLOOR

FLOOR: StringField<PurCtrAddress> = new StringField('Floor', PurCtrAddress, 'Edm.String')

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

Static FORM_OF_ADDRESS

FORM_OF_ADDRESS: StringField<PurCtrAddress> = new StringField('FormOfAddress', PurCtrAddress, 'Edm.String')

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

Static FULL_NAME

FULL_NAME: StringField<PurCtrAddress> = new StringField('FullName', PurCtrAddress, 'Edm.String')

Static representation of the fullName 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<PurCtrAddress> = new StringField('HouseNumber', PurCtrAddress, '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 HOUSE_NUMBER_SUPPLEMENT_TEXT

HOUSE_NUMBER_SUPPLEMENT_TEXT: StringField<PurCtrAddress> = new StringField('HouseNumberSupplementText', PurCtrAddress, 'Edm.String')

Static representation of the houseNumberSupplementText 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<PurCtrAddress> = new StringField('PhoneNumber', PurCtrAddress, '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<PurCtrAddress> = new StringField('PostalCode', PurCtrAddress, '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 PO_BOX

PO_BOX: StringField<PurCtrAddress> = new StringField('POBox', PurCtrAddress, 'Edm.String')

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

Static PO_BOX_DEVIATING_CITY_NAME

PO_BOX_DEVIATING_CITY_NAME: StringField<PurCtrAddress> = new StringField('POBoxDeviatingCityName', PurCtrAddress, 'Edm.String')

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

Static PO_BOX_POSTAL_CODE

PO_BOX_POSTAL_CODE: StringField<PurCtrAddress> = new StringField('POBoxPostalCode', PurCtrAddress, 'Edm.String')

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

Static PRFRD_COMM_MEDIUM_TYPE

PRFRD_COMM_MEDIUM_TYPE: StringField<PurCtrAddress> = new StringField('PrfrdCommMediumType', PurCtrAddress, 'Edm.String')

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

Static PURCHASE_CONTRACT

PURCHASE_CONTRACT: StringField<PurCtrAddress> = new StringField('PurchaseContract', PurCtrAddress, 'Edm.String')

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

Static PURCHASE_CONTRACT_ITEM

PURCHASE_CONTRACT_ITEM: StringField<PurCtrAddress> = new StringField('PurchaseContractItem', PurCtrAddress, 'Edm.String')

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

Static REGION

REGION: StringField<PurCtrAddress> = new StringField('Region', PurCtrAddress, '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 ROOM_NUMBER

ROOM_NUMBER: StringField<PurCtrAddress> = new StringField('RoomNumber', PurCtrAddress, 'Edm.String')

Static representation of the roomNumber 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<PurCtrAddress> = new StringField('StreetName', PurCtrAddress, '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<PurCtrAddress> = new StringField('StreetPrefixName', PurCtrAddress, '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<PurCtrAddress> = new StringField('StreetSuffixName', PurCtrAddress, '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 TAX_JURISDICTION

TAX_JURISDICTION: StringField<PurCtrAddress> = new StringField('TaxJurisdiction', PurCtrAddress, 'Edm.String')

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

Static TRANSPORT_ZONE

TRANSPORT_ZONE: StringField<PurCtrAddress> = new StringField('TransportZone', PurCtrAddress, 'Edm.String')

Static representation of the transportZone 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<PurCtrAddress>> = [PurCtrAddress.PURCHASE_CONTRACT,PurCtrAddress.ADDRESS_ID,PurCtrAddress.PURCHASE_CONTRACT_ITEM,PurCtrAddress.FORM_OF_ADDRESS,PurCtrAddress.FULL_NAME,PurCtrAddress.CONSIGNEE_NAME_3,PurCtrAddress.CONSIGNEE_NAME_4,PurCtrAddress.CARE_OF_NAME,PurCtrAddress.CITY_NAME,PurCtrAddress.DISTRICT,PurCtrAddress.CITY_CODE,PurCtrAddress.POSTAL_CODE,PurCtrAddress.PO_BOX_POSTAL_CODE,PurCtrAddress.COMPANY_POSTAL_CODE,PurCtrAddress.PO_BOX,PurCtrAddress.PO_BOX_DEVIATING_CITY_NAME,PurCtrAddress.STREET_NAME,PurCtrAddress.HOUSE_NUMBER,PurCtrAddress.STREET_PREFIX_NAME,PurCtrAddress.ADDITIONAL_STREET_PREFIX_NAME,PurCtrAddress.ADDITIONAL_STREET_SUFFIX_NAME,PurCtrAddress.BUILDING,PurCtrAddress.FLOOR,PurCtrAddress.ROOM_NUMBER,PurCtrAddress.COUNTRY,PurCtrAddress.CORRESPONDENCE_LANGUAGE,PurCtrAddress.REGION,PurCtrAddress.ADDRESS_TIME_ZONE,PurCtrAddress.TAX_JURISDICTION,PurCtrAddress.PRFRD_COMM_MEDIUM_TYPE,PurCtrAddress.PHONE_NUMBER,PurCtrAddress.FAX_NUMBER,PurCtrAddress.TRANSPORT_ZONE,PurCtrAddress.HOUSE_NUMBER_SUPPLEMENT_TEXT,PurCtrAddress.STREET_SUFFIX_NAME]

All fields of the PurCtrAddress entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_PurCtrAddress"

Technical entity name for PurCtrAddress.

Static _keyFields

_keyFields: Array<Selectable<PurCtrAddress>> = [PurCtrAddress.PURCHASE_CONTRACT, PurCtrAddress.ADDRESS_ID, PurCtrAddress.PURCHASE_CONTRACT_ITEM]

All key fields of the PurCtrAddress entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_PURCHASECONTRACT_PROCESS_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<PurCtrAddress>

    A builder that constructs instances of entity type PurCtrAddress.

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

    Returns PurCtrAddressRequestBuilder

    A PurCtrAddress request builder.