Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_AddressFaxNumber" of service "API_BUSINESS_PARTNER". This service is part of the following communication scenarios: Business Partner, Customer and Supplier Integration (SAP_COM_0008). See https://api.sap.com/api/API_BUSINESS_PARTNER for more information.

Hierarchy

  • Entity
    • AddressFaxNumber

Implements

Index

Constructors

constructor

  • Returns AddressFaxNumber

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 "*".

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 faxCountry

faxCountry: undefined | string

Country for telephone/fax number. The country for the telephone number or fax number is maintained here. This specification is used to determine the correct country code. A normalized form of the telephone number or fax number is then derived and stored in a field for a program-driven search.In most cases, the telephone number or fax number refers directly to an address.If this is the case, when a new number is created, the country of the address is proposed.If this is not the case (for example, with address-independent communication data for a business partner), the country from the user parameter LND is proposed (if it is maintained). If the user parameter LND is not maintained, the country of the company address assigned in the user master data is proposed.If the country of the address changes, the country of the corresponding telephone number and fax address is not changed automatically.Example: A business partner moves abroad.If the telephone number is for a permanent connection, the telephone number also changes when the business partner moves and has to be maintained again in the system.If the telephone number is for a mobile telephone and the number is retained, the original country for this telephone number also has to be retained and must not be changed automatically to the new country of the address. Maximum length: 3.

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 faxNumberExtension

faxNumberExtension: undefined | string

Fax no.: Extension. Fax extension number If the fax number consists of a company number and an extension, the extension must be entered here.Enter the extensionThe following rules apply for the format of telephone and fax numbers:The length of the entries in the field Telephone and Extension (Fax and Extension) cannot be more than 24 characters in total.Leading spaces are not allowed in the field Telephone or Fax or in the field Extension.Valid characters are:Numbers (0123456789)Letters (ABCDEFGHIJKLMNOPQRSTUVWXYZ)Following other characters: /, (, ), - *, # and " " (space), but not as a leading space.If an + is entered as the first character, the system checks whether the specified number starts with a country code. If so, a warning message is displayed because the country code is automatically determined by the system and should not be stored in the Telephone number (Fax number) field.If an & is entered as the first character, the automatic check and formatting of the telephone number (fax number), as well as the determination of the country code, is suppressed.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: 10.

nullable

Optional internationalFaxNumber

internationalFaxNumber: undefined | string

Complete number: dialling code+number+extension. The content of this field is automatically calculated by the system based on fax number and country code components. This field is therefore not to be filled when Business Address Services function modules are called. Maximum length: 30.

nullable

Optional isDefaultFaxNumber

isDefaultFaxNumber: undefined | false | true

Standard Sender Address in this Communication Type. If several addresses are maintained for one communication type, the user in the SAP System can be reached under one of these addresses. One address can be set as theStandard Address. The standard address is used for the following functions:When sending using the SMTP nodein SAPconnect, the home address of the communication type used is the one set as the sender address. The recipient can see this address in the sender information and can also reply directly to this address. The standard address is also transferred and can be used for incoming status notifications, for example.When sending using an RFC node in SAPconnect, the standard address of the communication type used is the one set as the sender address. The structure defined in the case of the RFC does not permit another address to be transferred, so the standard address is used for incoming status notifications too.The SAP users have the addresses of their exchange P.O. boxes in their standard communication type 'Internet Mail' as the home address and their Internet address in the SAP system as their standard address. Example:Home address: Bernard.Brown@Company.comStandard address: Bernard.Brown@System.Company.comSending using an SMTP nodeThe home address of the communication type 'Internet Mail' (Bernard.Brown@Company.com) is used as the sender address. If a reply is sent to this address the user receives directly in the exchange postbox.Sending using the RFC nodeThe standard address of the communication type 'Internet Mail' (Bernard.Brown@System.Company.com) is used as the sender address. If a reply is sent to this address, it arrives back to the SAP system.Example using a mail system groupThe users should get all messages in their Microsoft Exchange postboxes. In the SAP system the mail system group is activated for this using the setting "Send Messages to the Home Address".The address settings of the SAP users remain unchanged:Home address: Bernard.Brown@Company.comStandard address: Bernard.Brown@System.Company.comSending using an SMTP nodeThe home address of the communication type 'Internet Mail' (Bernard.Brown@Company.com) is used as the sender address. If a reply is sent to this address the user receives directly in the exchange postbox.Sending using the RFC nodeThe standard address of the communication type 'Internet Mail' (Bernard.Brown@System.Company.com) is used as the sender address. If a reply is sent to this address it arrives back in the SAP system. It is then forwarded using the mail system group to the home address and the user gets it in the exchange postbox.

nullable

ordinalNumber

ordinalNumber: string

Sequence Number. Maximum length: 3.

person

person: string

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

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

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

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

Static ADDRESS_ID

ADDRESS_ID: StringField<AddressFaxNumber> = new StringField('AddressID', AddressFaxNumber, '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 ALL_FIELDS

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

All fields selector.

Static FAX_COUNTRY

FAX_COUNTRY: StringField<AddressFaxNumber> = new StringField('FaxCountry', AddressFaxNumber, 'Edm.String')

Static representation of the faxCountry 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<AddressFaxNumber> = new StringField('FaxNumber', AddressFaxNumber, '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 FAX_NUMBER_EXTENSION

FAX_NUMBER_EXTENSION: StringField<AddressFaxNumber> = new StringField('FaxNumberExtension', AddressFaxNumber, 'Edm.String')

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

Static INTERNATIONAL_FAX_NUMBER

INTERNATIONAL_FAX_NUMBER: StringField<AddressFaxNumber> = new StringField('InternationalFaxNumber', AddressFaxNumber, 'Edm.String')

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

Static IS_DEFAULT_FAX_NUMBER

IS_DEFAULT_FAX_NUMBER: BooleanField<AddressFaxNumber> = new BooleanField('IsDefaultFaxNumber', AddressFaxNumber, 'Edm.Boolean')

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

Static ORDINAL_NUMBER

ORDINAL_NUMBER: StringField<AddressFaxNumber> = new StringField('OrdinalNumber', AddressFaxNumber, 'Edm.String')

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

Static PERSON

PERSON: StringField<AddressFaxNumber> = new StringField('Person', AddressFaxNumber, 'Edm.String')

Static representation of the person 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<AddressFaxNumber> | BooleanField<AddressFaxNumber>> = [AddressFaxNumber.ADDRESS_ID,AddressFaxNumber.PERSON,AddressFaxNumber.ORDINAL_NUMBER,AddressFaxNumber.IS_DEFAULT_FAX_NUMBER,AddressFaxNumber.FAX_COUNTRY,AddressFaxNumber.FAX_NUMBER,AddressFaxNumber.FAX_NUMBER_EXTENSION,AddressFaxNumber.INTERNATIONAL_FAX_NUMBER]

All fields of the AddressFaxNumber entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_AddressFaxNumber"

Technical entity name for AddressFaxNumber.

Static _keyFields

_keyFields: Array<Selectable<AddressFaxNumber>> = [AddressFaxNumber.ADDRESS_ID, AddressFaxNumber.PERSON, AddressFaxNumber.ORDINAL_NUMBER]

All key fields of the AddressFaxNumber entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_BUSINESS_PARTNER"
deprecated

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

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.

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<AddressFaxNumber>

    A builder that constructs instances of entity type AddressFaxNumber.

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

    Returns AddressFaxNumberRequestBuilder

    A AddressFaxNumber request builder.