Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_PlanCostRate" of service "API_FCO_COST_RATE_SRV". This service is part of the following communication scenarios: Finance - Activity Type Integration (SAP_COM_0129). See https://api.sap.com/api/API_FCO_COST_RATE_SRV for more information.

Hierarchy

  • Entity
    • PlanCostRate

Implements

Index

Constructors

constructor

  • Returns PlanCostRate

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

accountingCostRateUuid

accountingCostRateUuid: string

Cost Rate UUID.

Optional activityType

activityType: undefined | string

Activity Type. Key uniquely identifying . Activity types describe the activity produced by a cost center and are measured in units of time or quantity.In activity type planning, control data determines whether the activity price for evaluation of the activity type is manually set or is derived iteratively through activity price calculation. Maximum length: 6.

nullable

Optional companyCode

companyCode: undefined | string

Company Code. The company code is an organizational unit within financial accounting. Maximum length: 4.

nullable

Optional costCenter

costCenter: undefined | string

Cost Center. A key that uniquely identifies a cost center. Maximum length: 10.

nullable

Optional costCtrActivityTypeQtyUnit

costCtrActivityTypeQtyUnit: undefined | string

Activity Unit. The activity unit is either the time or quantity unit of an activity type used to post the activity quantity. In the databases, the activity type is always managed with the activity unit that is defined in activity type master record.The activity unit can no longer be changed in the activity type master record when dependent data already exists.Later plan or actual postings can result in varying activity units if these are convertable to a specified unit. Maximum length: 3.

nullable

Optional costRateFixedAmount

costRateFixedAmount: BigNumber

Fixed Rate.

nullable

Optional costRateIsOverwriteMode

costRateIsOverwriteMode: undefined | false | true

Truth Value: True/False.

nullable

Optional costRateScaleFactor

costRateScaleFactor: BigNumber

per.

nullable

Optional costRateVarblAmount

costRateVarblAmount: BigNumber

Variable Rate.

nullable

Optional currency

currency: undefined | string

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

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

Optional validityEndFiscalYearPeriod

validityEndFiscalYearPeriod: undefined | string

Fiscal Year + Fiscal Period. Fiscal Year + Fiscal Period. Maximum length: 7.

nullable

Optional validityStartFiscalYearPeriod

validityStartFiscalYearPeriod: undefined | string

Fiscal Year + Fiscal Period. Fiscal Year + Fiscal Period. Maximum length: 7.

nullable

Static ACCOUNTING_COST_RATE_UUID

ACCOUNTING_COST_RATE_UUID: StringField<PlanCostRate> = new StringField('AccountingCostRateUUID', PlanCostRate, 'Edm.Guid')

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

Static ACTIVITY_TYPE

ACTIVITY_TYPE: StringField<PlanCostRate> = new StringField('ActivityType', PlanCostRate, 'Edm.String')

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

Static ALL_FIELDS

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

All fields selector.

Static COMPANY_CODE

COMPANY_CODE: StringField<PlanCostRate> = new StringField('CompanyCode', PlanCostRate, 'Edm.String')

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

Static COST_CENTER

COST_CENTER: StringField<PlanCostRate> = new StringField('CostCenter', PlanCostRate, 'Edm.String')

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

Static COST_CTR_ACTIVITY_TYPE_QTY_UNIT

COST_CTR_ACTIVITY_TYPE_QTY_UNIT: StringField<PlanCostRate> = new StringField('CostCtrActivityTypeQtyUnit', PlanCostRate, 'Edm.String')

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

Static COST_RATE_FIXED_AMOUNT

COST_RATE_FIXED_AMOUNT: BigNumberField<PlanCostRate> = new BigNumberField('CostRateFixedAmount', PlanCostRate, 'Edm.Decimal')

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

Static COST_RATE_IS_OVERWRITE_MODE

COST_RATE_IS_OVERWRITE_MODE: BooleanField<PlanCostRate> = new BooleanField('CostRateIsOverwriteMode', PlanCostRate, 'Edm.Boolean')

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

Static COST_RATE_SCALE_FACTOR

COST_RATE_SCALE_FACTOR: BigNumberField<PlanCostRate> = new BigNumberField('CostRateScaleFactor', PlanCostRate, 'Edm.Decimal')

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

Static COST_RATE_VARBL_AMOUNT

COST_RATE_VARBL_AMOUNT: BigNumberField<PlanCostRate> = new BigNumberField('CostRateVarblAmount', PlanCostRate, 'Edm.Decimal')

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

Static CURRENCY

CURRENCY: StringField<PlanCostRate> = new StringField('Currency', PlanCostRate, 'Edm.String')

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

Static VALIDITY_END_FISCAL_YEAR_PERIOD

VALIDITY_END_FISCAL_YEAR_PERIOD: StringField<PlanCostRate> = new StringField('ValidityEndFiscalYearPeriod', PlanCostRate, 'Edm.String')

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

Static VALIDITY_START_FISCAL_YEAR_PERIOD

VALIDITY_START_FISCAL_YEAR_PERIOD: StringField<PlanCostRate> = new StringField('ValidityStartFiscalYearPeriod', PlanCostRate, 'Edm.String')

Static representation of the validityStartFiscalYearPeriod 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<PlanCostRate> | BigNumberField<PlanCostRate> | BooleanField<PlanCostRate>> = [PlanCostRate.ACCOUNTING_COST_RATE_UUID,PlanCostRate.COMPANY_CODE,PlanCostRate.COST_CENTER,PlanCostRate.ACTIVITY_TYPE,PlanCostRate.VALIDITY_START_FISCAL_YEAR_PERIOD,PlanCostRate.VALIDITY_END_FISCAL_YEAR_PERIOD,PlanCostRate.CURRENCY,PlanCostRate.COST_RATE_FIXED_AMOUNT,PlanCostRate.COST_RATE_VARBL_AMOUNT,PlanCostRate.COST_RATE_SCALE_FACTOR,PlanCostRate.COST_CTR_ACTIVITY_TYPE_QTY_UNIT,PlanCostRate.COST_RATE_IS_OVERWRITE_MODE]

All fields of the PlanCostRate entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_PlanCostRate"

Technical entity name for PlanCostRate.

Static _keyFields

_keyFields: Array<Selectable<PlanCostRate>> = [PlanCostRate.ACCOUNTING_COST_RATE_UUID]

All key fields of the PlanCostRate entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_FCO_COST_RATE_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<PlanCostRate>

    A builder that constructs instances of entity type PlanCostRate.

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

    Returns PlanCostRateRequestBuilder

    A PlanCostRate request builder.