Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_BPContactToFuncAndDept" 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
    • BpContactToFuncAndDept

Implements

Index

Constructors

constructor

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

businessPartnerCompany

businessPartnerCompany: string

Business Partner Number. Key identifying a business partner in the SAP system. The key is unique within a client. Maximum length: 10.

businessPartnerPerson

businessPartnerPerson: string

Business Partner Number. Key identifying a business partner in the SAP system. The key is unique within a client. Maximum length: 10.

Optional contactPersonDepartment

contactPersonDepartment: undefined | string

Department. Name of the department of a business partner for your internal usage. The name given by the business partner to this particular department may differ from the name that you use. You can enter the name given by the business partner in the field company department.This is a contact person attribute that you can define in Customizing.For your purposes, the department name is "Sales". The business partner names the same department "Sales South". Maximum length: 4.

nullable

Optional contactPersonFunction

contactPersonFunction: undefined | string

Function of partner. Identifies the function that a person has within a company. This is a contact person attribute that you can define in Customizing.Personnel managerSecretary. Maximum length: 4.

nullable

Optional emailAddress

emailAddress: undefined | 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 faxNumber

faxNumber: undefined | string

Fax number: dialling code+number. Fax number, consisting of dialling code and number, but without country dialling code. If the fax number consists of a company number and an extension, the extension must be entered in the field extension.Fax number, as it is to be dialled from within the same country.Enter the following for the number "01234/567-0":Fax: 01234/567Extension: 0Enter the following for the number "01234/567-891":Fax: 01234/567Extension: 891For the number "012-345-678" (678 as extension) enter the following:Fax: 012-345Extension: 678In the following cases, enter the complete number (without country dialing code) in the field Fax:No part of the number can be considered as an extension.You are not sure which part of the number can be considered as an extension. Maximum length: 30.

nullable

Optional faxNumberExtension

faxNumberExtension: undefined | string

Fax no.: Extension. Fax extension number If the fax number consists of a company number and an extension, the extension must be entered here.Enter the extensionThe following rules apply for the format of telephone and fax numbers:The length of the entries in the field Telephone and Extension (Fax and Extension) cannot be more than 24 characters in total.Leading spaces are not allowed in the field Telephone or Fax or in the field Extension.Valid characters are:Numbers (0123456789)Letters (ABCDEFGHIJKLMNOPQRSTUVWXYZ)Following other characters: /, (, ), - *, # and " " (space), but not as a leading space.If an + is entered as the first character, the system checks whether the specified number starts with a country code. If so, a warning message is displayed because the country code is automatically determined by the system and should not be stored in the Telephone number (Fax number) field.If an & is entered as the first character, the automatic check and formatting of the telephone number (fax number), as well as the determination of the country code, is suppressed.Enter the following for the number "01234/567-0":Fax: 01234/567Extension: 0Enter the following for the number "01234/567-891":Fax: 01234/567Extension: 891For the number "012-345-678" (678 as extension) enter the following:Fax: 012-345Extension: 678In the following cases, enter the complete number (without country dialing code) in the field Fax:No part of the number can be considered as an extension.You are not sure which part of the number can be considered as an extension. Maximum length: 10.

nullable

Optional phoneNumber

phoneNumber: undefined | string

Telephone no.: dialling code+number. Telephone number, consisting of dialling code and number, but without country dialling code. If the telephone number consists of a company number and an extension, the extension must be entered in the field extension.Telephone number, as it is dialled from within the country.For the number "01234/567-0" enter the following:Telephone: 01234/567Estension: 0For the number "01234/567-891" enter the following:Telephone: 01234/567Extension: 891For the number "012-345-678" (678 as extension) enter the following:Telepone: 012-345Extension: 678In the following cases enter the complete number (without country dialling code) in the field Telephone:No part of the number can be regarded as an extension.You are not sure which part of the number can be regarded as an extension. Maximum length: 30.

nullable

Optional phoneNumberExtension

phoneNumberExtension: undefined | string

Telephone no.: Extension. Telephone extension number If the telephone number consists of a company number and an extension, the extension should be entered here.Enter the extension.The following rules apply for the format of telephone and fax numbers:The length of the entries in the field Telephone and Extension (Fax and Extension) cannot be more than 24 characters in total.Leading spaces are not allowed in the field Telephone or Fax or in the field Extension.Valid characters are:Numbers (0123456789)Letters (ABCDEFGHIJKLMNOPQRSTUVWXYZ)Following other characters: /, (, ), - *, # and " " (space), but not as a leading space.If an + is entered as the first character, the system checks whether the specified number starts with a country code. If so, a warning message is displayed because the country code is automatically determined by the system and should not be stored in the Telephone number (Fax number) field.If an & is entered as the first character, the automatic check and formatting of the telephone number (fax number), as well as the determination of the country code, is suppressed.For the number "01234/567-0" enter the following:Telephone: 01234/567Estension: 0For the number "01234/567-891" enter the following:Telephone: 01234/567Extension: 891For the number "012-345-678" (678 as extension) enter the following:Telepone: 012-345Extension: 678In the following cases enter the complete number (without country dialling code) in the field Telephone:No part of the number can be regarded as an extension.You are not sure which part of the number can be regarded as an extension. Maximum length: 10.

nullable

Optional relationshipCategory

relationshipCategory: undefined | string

Business Partner Relationship Category. A relationship may exist between two business partners. The business partner relationship category characterizes the features of the relationship. A distinction is made between a one-way and an undirected business partner relationship category. In a one-way relationship category, the relationship extends from one partner to another, but not vice versa.Marriage (undirected)Employee (one-way)Contact person (one-way). Maximum length: 6.

nullable

relationshipNumber

relationshipNumber: string

BP Relationship Number. The business partner relationship number is an internal number that identifies the business partner relationship set. Maximum length: 12.

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

validityEndDate

validityEndDate: Moment

Validity Date (Valid To).

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

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

Static ALL_FIELDS

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

All fields selector.

Static BUSINESS_PARTNER_COMPANY

BUSINESS_PARTNER_COMPANY: StringField<BpContactToFuncAndDept> = new StringField('BusinessPartnerCompany', BpContactToFuncAndDept, 'Edm.String')

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

Static BUSINESS_PARTNER_PERSON

BUSINESS_PARTNER_PERSON: StringField<BpContactToFuncAndDept> = new StringField('BusinessPartnerPerson', BpContactToFuncAndDept, 'Edm.String')

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

Static CONTACT_PERSON_DEPARTMENT

CONTACT_PERSON_DEPARTMENT: StringField<BpContactToFuncAndDept> = new StringField('ContactPersonDepartment', BpContactToFuncAndDept, 'Edm.String')

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

Static CONTACT_PERSON_FUNCTION

CONTACT_PERSON_FUNCTION: StringField<BpContactToFuncAndDept> = new StringField('ContactPersonFunction', BpContactToFuncAndDept, 'Edm.String')

Static representation of the contactPersonFunction 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<BpContactToFuncAndDept> = new StringField('EmailAddress', BpContactToFuncAndDept, '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 FAX_NUMBER

FAX_NUMBER: StringField<BpContactToFuncAndDept> = new StringField('FaxNumber', BpContactToFuncAndDept, 'Edm.String')

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

Static FAX_NUMBER_EXTENSION

FAX_NUMBER_EXTENSION: StringField<BpContactToFuncAndDept> = new StringField('FaxNumberExtension', BpContactToFuncAndDept, 'Edm.String')

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

Static PHONE_NUMBER

PHONE_NUMBER: StringField<BpContactToFuncAndDept> = new StringField('PhoneNumber', BpContactToFuncAndDept, 'Edm.String')

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

Static PHONE_NUMBER_EXTENSION

PHONE_NUMBER_EXTENSION: StringField<BpContactToFuncAndDept> = new StringField('PhoneNumberExtension', BpContactToFuncAndDept, 'Edm.String')

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

Static RELATIONSHIP_CATEGORY

RELATIONSHIP_CATEGORY: StringField<BpContactToFuncAndDept> = new StringField('RelationshipCategory', BpContactToFuncAndDept, 'Edm.String')

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

Static RELATIONSHIP_NUMBER

RELATIONSHIP_NUMBER: StringField<BpContactToFuncAndDept> = new StringField('RelationshipNumber', BpContactToFuncAndDept, 'Edm.String')

Static representation of the relationshipNumber 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<BpContactToFuncAndDept> = new DateField('ValidityEndDate', BpContactToFuncAndDept, '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 _allFields

_allFields: Array<StringField<BpContactToFuncAndDept> | DateField<BpContactToFuncAndDept>> = [BpContactToFuncAndDept.RELATIONSHIP_NUMBER,BpContactToFuncAndDept.BUSINESS_PARTNER_COMPANY,BpContactToFuncAndDept.BUSINESS_PARTNER_PERSON,BpContactToFuncAndDept.VALIDITY_END_DATE,BpContactToFuncAndDept.CONTACT_PERSON_FUNCTION,BpContactToFuncAndDept.CONTACT_PERSON_DEPARTMENT,BpContactToFuncAndDept.PHONE_NUMBER,BpContactToFuncAndDept.PHONE_NUMBER_EXTENSION,BpContactToFuncAndDept.FAX_NUMBER,BpContactToFuncAndDept.FAX_NUMBER_EXTENSION,BpContactToFuncAndDept.EMAIL_ADDRESS,BpContactToFuncAndDept.RELATIONSHIP_CATEGORY]

All fields of the BpContactToFuncAndDept entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_BPContactToFuncAndDept"

Technical entity name for BpContactToFuncAndDept.

Static _keyFields

_keyFields: Array<Selectable<BpContactToFuncAndDept>> = [BpContactToFuncAndDept.RELATIONSHIP_NUMBER, BpContactToFuncAndDept.BUSINESS_PARTNER_COMPANY, BpContactToFuncAndDept.BUSINESS_PARTNER_PERSON, BpContactToFuncAndDept.VALIDITY_END_DATE]

All key fields of the BpContactToFuncAndDept entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_BUSINESS_PARTNER"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<BpContactToFuncAndDept>

    A builder that constructs instances of entity type BpContactToFuncAndDept.

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

    Returns BpContactToFuncAndDeptRequestBuilder

    A BpContactToFuncAndDept request builder.