Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_BuPaIndustry" 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
    • BuPaIndustry

Implements

Index

Constructors

constructor

  • Returns BuPaIndustry

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

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 industryKeyDescription

industryKeyDescription: undefined | string

Description. Maximum length: 100.

nullable

industrySector

industrySector: string

Industry. Describes an industry. An industry is a classification of companies according to their main business activity. For example, you can use Commerce, Banking, Services, Industry, Healthcare, Public Sector, Media, and so on, as industries.You can define industries along with their descriptions in Customizing.Assign the industry key to an industry key system. Maximum length: 10.

industrySystemType

industrySystemType: string

Industry System. Serves to combine and categorize several industries into a group. You can create different industry systems, each with its own catalog of industries, whereby an industry can be assigned to several industry systems.You have to select one industry system as the standard industry system. This is then automatically displayed in the initial screen for the maintenance of industry data.You can define an industry system along with its description in Customizing. You can assign several industry systems to a business partner.If you choose the button All Industry Systems, you can access all the industry systems defined in the Customizing using the input help. Maximum length: 4.

Optional isStandardIndustry

isStandardIndustry: undefined | string

Industry is Standard for BP in Industry System. Identifies the industry in an industry system that can be defined as the standard industry. It is recommended that you define an industry within an industry system as the standard industry, because only the standard industries can be determined at the interfaces to BW or the APIs, for example.This means that even if only one industry exists within an industry system, it should be indicated as the standard industry as this this information cannot be determined otherwise. Maximum length: 1.

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 the original OData properties.

Type declaration

  • [keys: string]: any

Static ALL_FIELDS

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

All fields selector.

Static BUSINESS_PARTNER

BUSINESS_PARTNER: StringField<BuPaIndustry> = new StringField('BusinessPartner', BuPaIndustry, '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 INDUSTRY_KEY_DESCRIPTION

INDUSTRY_KEY_DESCRIPTION: StringField<BuPaIndustry> = new StringField('IndustryKeyDescription', BuPaIndustry, 'Edm.String')

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

Static INDUSTRY_SECTOR

INDUSTRY_SECTOR: StringField<BuPaIndustry> = new StringField('IndustrySector', BuPaIndustry, 'Edm.String')

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

Static INDUSTRY_SYSTEM_TYPE

INDUSTRY_SYSTEM_TYPE: StringField<BuPaIndustry> = new StringField('IndustrySystemType', BuPaIndustry, 'Edm.String')

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

Static IS_STANDARD_INDUSTRY

IS_STANDARD_INDUSTRY: StringField<BuPaIndustry> = new StringField('IsStandardIndustry', BuPaIndustry, 'Edm.String')

Static representation of the isStandardIndustry 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<BuPaIndustry>> = [BuPaIndustry.INDUSTRY_SECTOR,BuPaIndustry.INDUSTRY_SYSTEM_TYPE,BuPaIndustry.BUSINESS_PARTNER,BuPaIndustry.IS_STANDARD_INDUSTRY,BuPaIndustry.INDUSTRY_KEY_DESCRIPTION]

All fields of the BuPaIndustry entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_BuPaIndustry"

Technical entity name for BuPaIndustry.

Static _keyFields

_keyFields: Array<Selectable<BuPaIndustry>> = [BuPaIndustry.INDUSTRY_SECTOR, BuPaIndustry.INDUSTRY_SYSTEM_TYPE, BuPaIndustry.BUSINESS_PARTNER]

All key fields of the BuPaIndustry entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_BUSINESS_PARTNER"
deprecated

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

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(): this
  • Returns a map of all defined fields in entity to their current values.

    Returns this

    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(): this
  • 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 this

    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

  • Returns an entity builder to construct instances BuPaIndustry.

    Returns EntityBuilderType<BuPaIndustry, BuPaIndustryTypeForceMandatory>

    A builder that constructs instances of entity type BuPaIndustry.

Static customField

  • Returns a selectable object that allows the selection of custom field in a get request for the entity BuPaIndustry.

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<BuPaIndustry>

    A builder that constructs instances of entity type BuPaIndustry.

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

    Returns BuPaIndustryRequestBuilder

    A BuPaIndustry request builder.