Options
All
  • Public
  • Public/Protected
  • All
Menu

Address Home Page URL

Hierarchy

  • Entity
    • AddressHomePageUrl

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.

isDefaultUrlAddress

isDefaultUrlAddress: boolean

Flag: this address is the default address.

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

searchUrlAddress

searchUrlAddress: string

URI address search field. Maximum length: 50.

nullable

urlFieldLength

urlFieldLength: number

URI field length.

nullable

validityStartDate

validityStartDate: Moment

Valid-from date - in current Release only 00010101 possible.

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

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

websiteUrl

websiteUrl: string

Universal Resource Identifier (URI). Maximum length: 2048.

nullable

Static ADDRESS_ID

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

IS_DEFAULT_URL_ADDRESS: BooleanField<AddressHomePageUrl> = new BooleanField('IsDefaultURLAddress', AddressHomePageUrl, 'Edm.Boolean')

Static representation of the isDefaultUrlAddress 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<AddressHomePageUrl> = new StringField('OrdinalNumber', AddressHomePageUrl, '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<AddressHomePageUrl> = new StringField('Person', AddressHomePageUrl, '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_URL_ADDRESS

SEARCH_URL_ADDRESS: StringField<AddressHomePageUrl> = new StringField('SearchURLAddress', AddressHomePageUrl, 'Edm.String')

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

Static URL_FIELD_LENGTH

URL_FIELD_LENGTH: NumberField<AddressHomePageUrl> = new NumberField('URLFieldLength', AddressHomePageUrl, 'Edm.Int16')

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

Static VALIDITY_START_DATE

VALIDITY_START_DATE: DateField<AddressHomePageUrl> = new DateField('ValidityStartDate', AddressHomePageUrl, 'Edm.DateTime')

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

Static WEBSITE_URL

WEBSITE_URL: StringField<AddressHomePageUrl> = new StringField('WebsiteURL', AddressHomePageUrl, 'Edm.String')

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

Static _allFields

_allFields: (StringField<AddressHomePageUrl> | DateField<AddressHomePageUrl> | BooleanField<AddressHomePageUrl> | NumberField<AddressHomePageUrl>)[] = [AddressHomePageUrl.ADDRESS_ID,AddressHomePageUrl.PERSON,AddressHomePageUrl.ORDINAL_NUMBER,AddressHomePageUrl.VALIDITY_START_DATE,AddressHomePageUrl.IS_DEFAULT_URL_ADDRESS,AddressHomePageUrl.SEARCH_URL_ADDRESS,AddressHomePageUrl.URL_FIELD_LENGTH,AddressHomePageUrl.WEBSITE_URL]

All fields of the AddressHomePageUrl entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_AddressHomePageURL"

Technical entity name for AddressHomePageUrl.

Static _keyFields

_keyFields: Array<Selectable<AddressHomePageUrl>> = [AddressHomePageUrl.ADDRESS_ID, AddressHomePageUrl.PERSON, AddressHomePageUrl.ORDINAL_NUMBER, AddressHomePageUrl.VALIDITY_START_DATE, AddressHomePageUrl.IS_DEFAULT_URL_ADDRESS]

All key fields of the AddressHomePageUrl entity.

Static _keys

_keys: any = AddressHomePageUrl._keyFields.reduce((acc: any, field) => {acc[field.fieldName] = field;return acc;}, {})

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

Static _serviceName

_serviceName: string = "API_BUSINESS_PARTNER"

Technical service name for AddressHomePageUrl.

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

    Returns AddressHomePageUrlRequestBuilder

    A AddressHomePageUrl request builder.