Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "BaseUnit" of service "API_GRMASTERDATA_SRV". This service is part of the following communication scenarios: Finance - Cloud Consolidation Master Data for Group Reporting Integration (SAP_COM_0336), Finance - Cloud Consolidation Data Collection Integration (SAP_COM_0241), Finance - Group Reporting Planning Integration (SAP_COM_0370). See https://api.sap.com/api/API_GRMASTERDATA_SRV for more information.

Hierarchy

  • Entity
    • BaseUnit

Implements

Index

Constructors

constructor

  • Returns BaseUnit

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

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

toCnsldtnBaseUnitT

toCnsldtnBaseUnitT: BaseUnitText[]

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

unitOfMeasure

unitOfMeasure: string

Unit of Measurement. Internal, language-independent, measurement unit format. This format is used for internal processing.The internal format is automatically replaced by either the external commercial (three-character) or technical (six-character) format before output to the screen. Maximum length: 3.

Optional unitOfMeasureDspNmbrOfDcmls

unitOfMeasureDspNmbrOfDcmls: undefined | number

Number of decimal places for number display. This parameter determines the number of decimal places with which this measurement unit is displayed.

nullable

Optional unitOfMeasureIsoCode

unitOfMeasureIsoCode: undefined | string

ISO code for unit of measurement. ISO code for measurement units. An ISO code can be assigned to several internal measurement units of a dimension. The ISO code is important for EDI. It is used to convert the internal SAP measurement units into standard measurement units. Data exchange via EDI requires internal measurement units to be converted into standard measurement units.A list of the current internationally agreed ISO codes can be ordered from the UN commission responsible (WP.4 Trade Facilitation Recommendations, Recommendation 20):UN Economic Commission for EuropeInformation OfficePalais des Nations1211 GenevaSwitzerlande-mail: info.ece@unece.orgor viewed directly on the Internet:http://www.unece.org/cefact/codesfortrade/codes_index.htmFor more information, see SAP Note 69063. Maximum length: 3.

nullable

Optional unitOfMeasureNumberOfDecimals

unitOfMeasureNumberOfDecimals: undefined | number

No. of decimal places for rounding. Specifies the number of decimal places to which this measurement unit should be rounded.

nullable

Optional unitOfMeasureText

unitOfMeasureText: undefined | string

Base Unit Description. Maximum length: 10.

nullable

Static ALL_FIELDS

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

All fields selector.

Static TO_CNSLDTN_BASE_UNIT_T

TO_CNSLDTN_BASE_UNIT_T: Link<BaseUnit, BaseUnitText> = new Link('to_CnsldtnBaseUnitT', BaseUnit, BaseUnitText)

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

Static UNIT_OF_MEASURE

UNIT_OF_MEASURE: StringField<BaseUnit> = new StringField('UnitOfMeasure', BaseUnit, 'Edm.String')

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

Static UNIT_OF_MEASURE_DSP_NMBR_OF_DCMLS

UNIT_OF_MEASURE_DSP_NMBR_OF_DCMLS: NumberField<BaseUnit> = new NumberField('UnitOfMeasureDspNmbrOfDcmls', BaseUnit, 'Edm.Int16')

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

Static UNIT_OF_MEASURE_ISO_CODE

UNIT_OF_MEASURE_ISO_CODE: StringField<BaseUnit> = new StringField('UnitOfMeasureISOCode', BaseUnit, 'Edm.String')

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

Static UNIT_OF_MEASURE_NUMBER_OF_DECIMALS

UNIT_OF_MEASURE_NUMBER_OF_DECIMALS: NumberField<BaseUnit> = new NumberField('UnitOfMeasureNumberOfDecimals', BaseUnit, 'Edm.Int16')

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

Static UNIT_OF_MEASURE_TEXT

UNIT_OF_MEASURE_TEXT: StringField<BaseUnit> = new StringField('UnitOfMeasure_Text', BaseUnit, 'Edm.String')

Static representation of the unitOfMeasureText 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<BaseUnit> | NumberField<BaseUnit> | Link<BaseUnit, BaseUnitText>> = [BaseUnit.UNIT_OF_MEASURE,BaseUnit.UNIT_OF_MEASURE_TEXT,BaseUnit.UNIT_OF_MEASURE_ISO_CODE,BaseUnit.UNIT_OF_MEASURE_NUMBER_OF_DECIMALS,BaseUnit.UNIT_OF_MEASURE_DSP_NMBR_OF_DCMLS,BaseUnit.TO_CNSLDTN_BASE_UNIT_T]

All fields of the BaseUnit entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "BaseUnit"

Technical entity name for BaseUnit.

Static _keyFields

_keyFields: Array<Selectable<BaseUnit>> = [BaseUnit.UNIT_OF_MEASURE]

All key fields of the BaseUnit entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_GRMASTERDATA_SRV"
deprecated

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

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

  • customField(fieldName: string): CustomField<BaseUnit>
  • Returns a selectable object that allows the selection of custom field in a get request for the entity BaseUnit.

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<BaseUnit>

    A builder that constructs instances of entity type BaseUnit.

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

    Returns BaseUnitRequestBuilder

    A BaseUnit request builder.