Options
All
  • Public
  • Public/Protected
  • All
Menu

Address Email Address

Hierarchy

  • Entity
    • AddressEmailAddress

Implements

Index

Properties

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.

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

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

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 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: (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: any = AddressEmailAddress._keyFields.reduce((acc: any, field) => {acc[field.fieldName] = field;return acc;}, {})

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

Static _serviceName

_serviceName: string = "API_BUSINESS_PARTNER"

Technical service name for AddressEmailAddress.

Methods

Protected getCurrentMapKeys

  • getCurrentMapKeys(): this
  • Returns this

getUpdatedProperties

  • getUpdatedProperties(): this
  • Returns all changed properties compared to the last known remote state.

    Returns this

    Entity with all properties that changed

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.

    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

Static builder

Static Protected entityBuilder

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

    • EntityT: Entity

    • JsonT

    Parameters

    • entityConstructor: Constructable<EntityT>

    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.