• Public
  • Public/Protected
  • All

This class represents the entity "A_FunctionalArea" of service "API_FUNCTIONALAREA_SRV". This service is part of the following communication scenarios: SAP Analytics Cloud for Planning Integration (SAP_COM_0087). See https://api.sap.com/api/API_FUNCTIONALAREA_SRV for more information.


  • Entity
    • FunctionalArea





  • Returns FunctionalArea


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


functionalArea: string

Functional Area. Structure criterion for an enterprise or government based on functional aspects. Use for Cost-of-Sales AccountingThe functional area is required to create a profit and loss account in Financial Accounting using cost-of-sales accounting. The following are examples of structure criteria:ManufacturingAdministrationSalesResearch and developmentUse for GovernmentThe functional area is needed for Funds Management to meet legal requirements for reporting with functional aspects. You can use the functional area to represent the global targets and goals (such as public safety or city development), in particular the expenses of your organization.Use in cost-of-sales accountingSee the documentation on Filling the Functional Area Field.For comprehensive information on cost-of-sales accounting and on the functional area, see the SAP Library under Accounting -> Financial Accounting -> General Ledger -> Cost-of-Sales Accounting.Use in governmentFor more information on the functional area, see the implementation Guide for Funds Management Government in the section Activate Account Assignment Elements. Maximum length: 16.

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


One-to-many navigation property to the FunctionalAreaText entity.


versionIdentifier: string

ETag version identifier accessor.


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


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

All fields selector.


FUNCTIONAL_AREA: StringField<FunctionalArea> = new StringField('FunctionalArea', FunctionalArea, 'Edm.String')

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

Static TO_TEXT

TO_TEXT: Link<FunctionalArea, FunctionalAreaText> = new Link('to_Text', FunctionalArea, FunctionalAreaText)

Static representation of the one-to-many navigation property toText for query construction. Use to reference this property in query operations such as 'select' in the fluent request API.

Static _allFields

_allFields: Array<StringField<FunctionalArea> | Link<FunctionalArea, FunctionalAreaText>> = [FunctionalArea.FUNCTIONAL_AREA,FunctionalArea.TO_TEXT]

All fields of the FunctionalArea entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_FunctionalArea"

Technical entity name for FunctionalArea.

Static _keyFields

_keyFields: Array<Selectable<FunctionalArea>> = [FunctionalArea.FUNCTIONAL_AREA]

All key fields of the FunctionalArea entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_FUNCTIONALAREA_SRV"

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


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(fieldName: string): any
  • Custom field value getter.


    • fieldName: string

      The name of the custom field

    Returns any

    The value of the corresponding custom field


  • 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(): 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(): 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(fieldName: string): boolean
  • Validates whether a custom field exists in the entity.


    • 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(customFields: MapType<any>): this
  • Sets all retrieved custom fields in entity.


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


    • customFieldName: string

      Field name to check

    Returns boolean

    Boolean value that describes whether a field name can be defined as custom field


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


    • 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(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.


    Since 1.12.0. Will be removed in version 2.0.


    • Optional state: MapType<any>

      State to be set as remote state

    Returns this

    The entity itself, to facilitate method chaining


  • setVersionIdentifier(etag: string | undefined): this
  • Set the ETag version identifier of the retrieved entity.


    • etag: string | undefined

      The returned ETag version of the entity

    Returns this

    The entity itself, to facilitate method chaining


  • 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 FunctionalArea.


    • fieldName: string

      Name of the custom field to select

    Returns CustomField<FunctionalArea>

    A builder that constructs instances of entity type FunctionalArea.

Static Protected customFieldSelector

  • customFieldSelector<EntityT>(fieldName: string, entityConstructor: Constructable<EntityT>): CustomField<EntityT>
  • Type parameters

    • EntityT: Entity


    • 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


    • entityConstructor: Constructable<EntityT, EntityTypeForceMandatoryT>

    Returns EntityBuilderType<EntityT, EntityTypeForceMandatoryT>

Static requestBuilder

  • Returns a request builder to construct requests for operations on the FunctionalArea entity type.

    Returns FunctionalAreaRequestBuilder

    A FunctionalArea request builder.