Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Implements

Index

Constructors

constructor

  • Returns AddressEmailAddress

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 emailAddress

emailAddress: 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 isDefaultEmailAddress

isDefaultEmailAddress: boolean

Flag: this address is the default address.

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

Optional searchEmailAddress

searchEmailAddress: string

E-Mail Address Search Field. This field is generated by the system from the complete Internet mail address and is stored in table ADR6. It contains the first 20 characters of the Internet mail address in normalized form, that is, without comment characters and converted into uppercase.The field cannot be maintained by the user or from an interface.The table ADR6 contains an index for this field.Using an Internet mail address, the corresponding key of table ADR6 and the owner of the address are determined (for example, business partner or user). Maximum length: 20.

nullable

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<AddressEmailAddress> = new StringField('AddressID', AddressEmailAddress, '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<AddressEmailAddress> = new AllFields('*', AddressEmailAddress)

All fields selector.

Static EMAIL_ADDRESS

EMAIL_ADDRESS: StringField<AddressEmailAddress> = new StringField('EmailAddress', AddressEmailAddress, '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 IS_DEFAULT_EMAIL_ADDRESS

IS_DEFAULT_EMAIL_ADDRESS: BooleanField<AddressEmailAddress> = new BooleanField('IsDefaultEmailAddress', AddressEmailAddress, 'Edm.Boolean')

Static representation of the isDefaultEmailAddress 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<AddressEmailAddress> = new StringField('OrdinalNumber', AddressEmailAddress, '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<AddressEmailAddress> = new StringField('Person', AddressEmailAddress, '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 SEARCH_EMAIL_ADDRESS

SEARCH_EMAIL_ADDRESS: StringField<AddressEmailAddress> = new StringField('SearchEmailAddress', AddressEmailAddress, 'Edm.String')

Static representation of the searchEmailAddress 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<AddressEmailAddress> | BooleanField<AddressEmailAddress>> = [AddressEmailAddress.ADDRESS_ID,AddressEmailAddress.PERSON,AddressEmailAddress.ORDINAL_NUMBER,AddressEmailAddress.IS_DEFAULT_EMAIL_ADDRESS,AddressEmailAddress.EMAIL_ADDRESS,AddressEmailAddress.SEARCH_EMAIL_ADDRESS]

All fields of the AddressEmailAddress entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_AddressEmailAddress"

Technical entity name for AddressEmailAddress.

Static _keyFields

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

All key fields of the AddressEmailAddress entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_BUSINESS_PARTNER"
deprecated

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

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): this
  • Set the ETag version identifier of the retrieved entity.

    Parameters

    • etag: string

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<AddressEmailAddress>

    A builder that constructs instances of entity type AddressEmailAddress.

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, JsonT>(entityConstructor: Constructable<EntityT, JsonT>): EntityBuilderType<EntityT, JsonT>
  • Type parameters

    • EntityT: Entity

    • JsonT

    Parameters

    • entityConstructor: Constructable<EntityT, JsonT>

    Returns EntityBuilderType<EntityT, JsonT>

Static requestBuilder

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

    Returns AddressEmailAddressRequestBuilder

    A AddressEmailAddress request builder.