Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Hierarchy

  • Entity
    • BuPaIdentification

Implements

Index

Constructors

constructor

  • Returns BuPaIdentification

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

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

Optional bpIdentificationEntryDate

bpIdentificationEntryDate: Moment

Date of Entry for ID Number. Date on which the ID number was registered or assigned by the appropriate authority.

nullable

bpIdentificationNumber

bpIdentificationNumber: string

Identification Number. Number that serves to identify a business partner, such as driver's license, or ID card number. Maximum length: 60.

bpIdentificationType

bpIdentificationType: string

Identification Type. A document (such as an ID card or driver's license) or an entry in a system of records (such as a commercial register) whose key can be stored as an attribute for a business partner. The identification type is for classifying identification numbers.You can define the identification types and their descriptions in Customizing.You can also specify for which business partner category an ID type should be valid.If necessary, assign the identification type to an Identification Category.You can only assign one identification type to an identification category. Maximum length: 6.

Optional bpIdnNmbrIssuingInstitute

bpIdnNmbrIssuingInstitute: undefined | string

Responsible Institution for ID Number. Institution that adminsters or assigns an ID number. Maximum length: 40.

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.

Optional country

country: undefined | string

Country in Which ID Number is Valid or Was Assigned. Country in which an ID number was assigned, or in which the number is valid. Maximum length: 3.

nullable

Optional region

region: undefined | string

Region (State, Province, County). In some countries, the region forms part of the address. The meaning depends on the country. The automatic address formatting function prints the region in addresses in the USA, Canada, Italy, Brazil or Australia, and the county in Great Britain.For more information, see the examples in the documentation on the Address Layout Key.Meaning of the regional code in ...Australia -> ProvinceBrazil -> StateCanada -> ProvinceGermany -> StateGreat Britain -> CountyItaly -> ProvinceJapan -> PrefectureSwitzerland -> CantonUSA -> State. Maximum length: 3.

nullable

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 validityEndDate

validityEndDate: Moment

Validity End for ID Number. This date marks the end of validity of an ID number.

nullable

Optional validityStartDate

validityStartDate: Moment

Validity Start for ID Number. This date marks the start of validity of an ID number.

nullable

Static ALL_FIELDS

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

All fields selector.

Static AUTHORIZATION_GROUP

AUTHORIZATION_GROUP: StringField<BuPaIdentification> = new StringField('AuthorizationGroup', BuPaIdentification, '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 BP_IDENTIFICATION_ENTRY_DATE

BP_IDENTIFICATION_ENTRY_DATE: DateField<BuPaIdentification> = new DateField('BPIdentificationEntryDate', BuPaIdentification, 'Edm.DateTime')

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

Static BP_IDENTIFICATION_NUMBER

BP_IDENTIFICATION_NUMBER: StringField<BuPaIdentification> = new StringField('BPIdentificationNumber', BuPaIdentification, 'Edm.String')

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

Static BP_IDENTIFICATION_TYPE

BP_IDENTIFICATION_TYPE: StringField<BuPaIdentification> = new StringField('BPIdentificationType', BuPaIdentification, 'Edm.String')

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

Static BP_IDN_NMBR_ISSUING_INSTITUTE

BP_IDN_NMBR_ISSUING_INSTITUTE: StringField<BuPaIdentification> = new StringField('BPIdnNmbrIssuingInstitute', BuPaIdentification, 'Edm.String')

Static representation of the bpIdnNmbrIssuingInstitute 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<BuPaIdentification> = new StringField('BusinessPartner', BuPaIdentification, '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 COUNTRY

COUNTRY: StringField<BuPaIdentification> = new StringField('Country', BuPaIdentification, 'Edm.String')

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

Static REGION

REGION: StringField<BuPaIdentification> = new StringField('Region', BuPaIdentification, 'Edm.String')

Static representation of the region 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<BuPaIdentification> = new DateField('ValidityEndDate', BuPaIdentification, 'Edm.DateTime')

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<BuPaIdentification> = new DateField('ValidityStartDate', BuPaIdentification, '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 _allFields

_allFields: Array<StringField<BuPaIdentification> | DateField<BuPaIdentification>> = [BuPaIdentification.BUSINESS_PARTNER,BuPaIdentification.BP_IDENTIFICATION_TYPE,BuPaIdentification.BP_IDENTIFICATION_NUMBER,BuPaIdentification.BP_IDN_NMBR_ISSUING_INSTITUTE,BuPaIdentification.BP_IDENTIFICATION_ENTRY_DATE,BuPaIdentification.COUNTRY,BuPaIdentification.REGION,BuPaIdentification.VALIDITY_START_DATE,BuPaIdentification.VALIDITY_END_DATE,BuPaIdentification.AUTHORIZATION_GROUP]

All fields of the BuPaIdentification entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_BuPaIdentification"

Technical entity name for BuPaIdentification.

Static _keyFields

_keyFields: Array<Selectable<BuPaIdentification>> = [BuPaIdentification.BUSINESS_PARTNER, BuPaIdentification.BP_IDENTIFICATION_TYPE, BuPaIdentification.BP_IDENTIFICATION_NUMBER]

All key fields of the BuPaIdentification entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_BUSINESS_PARTNER"
deprecated

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

Accessors

versionIdentifier

  • get versionIdentifier(): string
  • ETag version identifier accessor.

    Returns string

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

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.

    deprecated

    Since 1.12.0. Will be removed in version 2.0.

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<BuPaIdentification>

    A builder that constructs instances of entity type BuPaIdentification.

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

    Returns BuPaIdentificationRequestBuilder

    A BuPaIdentification request builder.