Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_ControllingArea" of service "API_CONTROLLINGAREA_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_CONTROLLINGAREA_SRV for more information.

Hierarchy

  • Entity
    • ControllingArea

Implements

Index

Constructors

constructor

  • Returns ControllingArea

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 chartOfAccounts

chartOfAccounts: undefined | string

Chart of Accounts. Key that uniquely identifies a chart of accounts. Maximum length: 4.

nullable

controllingArea

controllingArea: string

Controlling Area. Maximum length: 4.

Optional controllingAreaCurrency

controllingAreaCurrency: undefined | string

Currency Key. Currency key for amounts in the system. Maximum length: 5.

nullable

Optional controllingAreaCurrencyRole

controllingAreaCurrencyRole: undefined | string

Currency Type for Controlling Area. Currency type defined for a controlling area. Maximum length: 2.

nullable

Optional controllingAreaName

controllingAreaName: undefined | string

Controlling Area Name. Maximum length: 25.

nullable

Optional costCenterStandardHierarchy

costCenterStandardHierarchy: undefined | string

Standard Hierarchy for Cost Centers. Indicated hierarchy of cost center groups in which all cost centers in a controlling area are gathered together. See standard hierarchy. Maximum length: 12.

nullable

Optional financialManagementArea

financialManagementArea: undefined | string

Financial Management Area. Key identifying an FM area. An FM area is an organizational unit which plans, controls and monitors funds and commitment budgets. Maximum length: 4.

nullable

Optional fiscalYearVariant

fiscalYearVariant: undefined | string

Fiscal Year Variant. Maximum length: 2.

nullable

Optional profitCenterAccountingCurrency

profitCenterAccountingCurrency: undefined | string

Local Currency for Profit Center Accounting. If you chose the special profit center currency as the currency type for a controlling area, you need to specify that currency in this field. If you chose the group currency or controlling area currency as the currency type, leave the field "Report currency" blank. The system will determine the currency automatically when the transaction data is posted.When transaction data is posted to Profit Center Accounting, the system also posts the data using the currency specified in the fields "Currency type"/"Report currency".NoteThe standard reports for Profit Center Accounting display the selected values in this currency. Maximum length: 5.

nullable

Optional profitCenterStandardHierarchy

profitCenterStandardHierarchy: undefined | string

Profit center area. The standard hierarchy is a tree structure which displays the organization of all the profit centers in one controlling area. The structural elements in the standard hierarchy are the profit center area and the summarization area.The profit center area is an end point in the tree structure which is not at the top and can have profit centers assigned to it when you maintain the standard hierarchy.The summarization area is used to summarize the data on the profit centers beneath it, although it does not itself contain any profit centers.By definition, the system always regards the profit center hierarchy which was entered when the controlling area was created as the standard hierarchy. Maximum length: 12.

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

Static ALL_FIELDS

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

All fields selector.

Static CHART_OF_ACCOUNTS

CHART_OF_ACCOUNTS: StringField<ControllingArea> = new StringField('ChartOfAccounts', ControllingArea, 'Edm.String')

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

Static CONTROLLING_AREA

CONTROLLING_AREA: StringField<ControllingArea> = new StringField('ControllingArea', ControllingArea, 'Edm.String')

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

Static CONTROLLING_AREA_CURRENCY

CONTROLLING_AREA_CURRENCY: StringField<ControllingArea> = new StringField('ControllingAreaCurrency', ControllingArea, 'Edm.String')

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

Static CONTROLLING_AREA_CURRENCY_ROLE

CONTROLLING_AREA_CURRENCY_ROLE: StringField<ControllingArea> = new StringField('ControllingAreaCurrencyRole', ControllingArea, 'Edm.String')

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

Static CONTROLLING_AREA_NAME

CONTROLLING_AREA_NAME: StringField<ControllingArea> = new StringField('ControllingAreaName', ControllingArea, 'Edm.String')

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

Static COST_CENTER_STANDARD_HIERARCHY

COST_CENTER_STANDARD_HIERARCHY: StringField<ControllingArea> = new StringField('CostCenterStandardHierarchy', ControllingArea, 'Edm.String')

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

Static FINANCIAL_MANAGEMENT_AREA

FINANCIAL_MANAGEMENT_AREA: StringField<ControllingArea> = new StringField('FinancialManagementArea', ControllingArea, 'Edm.String')

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

Static FISCAL_YEAR_VARIANT

FISCAL_YEAR_VARIANT: StringField<ControllingArea> = new StringField('FiscalYearVariant', ControllingArea, 'Edm.String')

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

Static PROFIT_CENTER_ACCOUNTING_CURRENCY

PROFIT_CENTER_ACCOUNTING_CURRENCY: StringField<ControllingArea> = new StringField('ProfitCenterAccountingCurrency', ControllingArea, 'Edm.String')

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

Static PROFIT_CENTER_STANDARD_HIERARCHY

PROFIT_CENTER_STANDARD_HIERARCHY: StringField<ControllingArea> = new StringField('ProfitCenterStandardHierarchy', ControllingArea, 'Edm.String')

Static representation of the profitCenterStandardHierarchy 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<ControllingArea>> = [ControllingArea.CONTROLLING_AREA,ControllingArea.FISCAL_YEAR_VARIANT,ControllingArea.CONTROLLING_AREA_NAME,ControllingArea.CONTROLLING_AREA_CURRENCY,ControllingArea.CHART_OF_ACCOUNTS,ControllingArea.COST_CENTER_STANDARD_HIERARCHY,ControllingArea.PROFIT_CENTER_STANDARD_HIERARCHY,ControllingArea.FINANCIAL_MANAGEMENT_AREA,ControllingArea.CONTROLLING_AREA_CURRENCY_ROLE,ControllingArea.PROFIT_CENTER_ACCOUNTING_CURRENCY]

All fields of the ControllingArea entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_ControllingArea"

Technical entity name for ControllingArea.

Static _keyFields

_keyFields: Array<Selectable<ControllingArea>> = [ControllingArea.CONTROLLING_AREA]

All key fields of the ControllingArea entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_CONTROLLINGAREA_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<ControllingArea>

    A builder that constructs instances of entity type ControllingArea.

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

    Returns ControllingAreaRequestBuilder

    A ControllingArea request builder.