Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_BuPaAddressUsage" 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
    • BuPaAddressUsage

Implements

Index

Constructors

constructor

  • Returns BuPaAddressUsage

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.

addressUsage

addressUsage: string

Address Type. Business partner attribute, which you can use to distinguish between various addresses by defining the address usage for communication with business partners. Maintain the usage types for addresses (address types) in Customizing.You can create a short description and a name for the address type.When maintaining business partners you can use the function address usage to assign business partner addresses to address types.If necessary, you can set the indicator for multiple use in Customizing.Correspondence addressDelivery address. Maximum length: 10.

Optional authorizationGroup

authorizationGroup: undefined | string

Authorization Group. You can use authorization groups to stipulate which business partners a user is allowed to process. Use the following authorization object:'Business partners: authorization groups' (B_BUPA_GRP).The system only checks this authorization if you made an entry in the "Authorization group" field for the business partner. Otherwise, any user may process the business partner. Maximum length: 4.

nullable

businessPartner

businessPartner: string

Business Partner Number. Key identifying a business partner in the SAP system. The key is unique within a client. 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 standardUsage

standardUsage: undefined | false | true

Indicator: Standard Address Usage. Establishes which is the standard address for an address usage. Several addresses per period can be assigned to an address usage.If this is the case, then this indicator controls which of the assigned addresses should be the standard address of the relevant usage. This is determined automatically when the address usage is accessed.

nullable

validityEndDate

validityEndDate: Moment

Validity End of a Business Partner Address Usage.

Optional validityStartDate

validityStartDate: Moment

Validity Start of a Business Partner Address Usage.

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<BuPaAddressUsage> = new StringField('AddressID', BuPaAddressUsage, '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_USAGE

ADDRESS_USAGE: StringField<BuPaAddressUsage> = new StringField('AddressUsage', BuPaAddressUsage, 'Edm.String')

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

All fields selector.

Static AUTHORIZATION_GROUP

AUTHORIZATION_GROUP: StringField<BuPaAddressUsage> = new StringField('AuthorizationGroup', BuPaAddressUsage, 'Edm.String')

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

Static BUSINESS_PARTNER

BUSINESS_PARTNER: StringField<BuPaAddressUsage> = new StringField('BusinessPartner', BuPaAddressUsage, 'Edm.String')

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

Static STANDARD_USAGE

STANDARD_USAGE: BooleanField<BuPaAddressUsage> = new BooleanField('StandardUsage', BuPaAddressUsage, 'Edm.Boolean')

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

Static VALIDITY_END_DATE

VALIDITY_END_DATE: DateField<BuPaAddressUsage> = new DateField('ValidityEndDate', BuPaAddressUsage, 'Edm.DateTimeOffset')

Static representation of the validityEndDate 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<BuPaAddressUsage> = new DateField('ValidityStartDate', BuPaAddressUsage, 'Edm.DateTimeOffset')

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 _allFields

_allFields: Array<StringField<BuPaAddressUsage> | DateField<BuPaAddressUsage> | BooleanField<BuPaAddressUsage>> = [BuPaAddressUsage.BUSINESS_PARTNER,BuPaAddressUsage.VALIDITY_END_DATE,BuPaAddressUsage.ADDRESS_USAGE,BuPaAddressUsage.ADDRESS_ID,BuPaAddressUsage.VALIDITY_START_DATE,BuPaAddressUsage.STANDARD_USAGE,BuPaAddressUsage.AUTHORIZATION_GROUP]

All fields of the BuPaAddressUsage entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_BuPaAddressUsage"

Technical entity name for BuPaAddressUsage.

Static _keyFields

_keyFields: Array<Selectable<BuPaAddressUsage>> = [BuPaAddressUsage.BUSINESS_PARTNER, BuPaAddressUsage.VALIDITY_END_DATE, BuPaAddressUsage.ADDRESS_USAGE, BuPaAddressUsage.ADDRESS_ID]

All key fields of the BuPaAddressUsage entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_BUSINESS_PARTNER"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<BuPaAddressUsage>

    A builder that constructs instances of entity type BuPaAddressUsage.

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

    Returns BuPaAddressUsageRequestBuilder

    A BuPaAddressUsage request builder.