Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_ProductValuation" of service "API_PRODUCT_SRV". This service is part of the following communication scenarios: Product Integration (SAP_COM_0009), Distributed Manufacturing Integration (SAP_COM_0077), SAP Analytics Cloud for Planning Integration (SAP_COM_0087). See https://api.sap.com/api/API_PRODUCT_SRV for more information.

Hierarchy

  • Entity
    • ProductValuation

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns ProductValuation

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 futurePlndPrice1ValdtyDate

futurePlndPrice1ValdtyDate: Moment

Date from Which Future Planned Price 1 Is Valid. Date as from which planned price 1 is valid for the material.

nullable

Optional futurePlndPrice2ValdtyDate

futurePlndPrice2ValdtyDate: Moment

Date from Which Future Planned Price 2 Is Valid. Date as from which planned price 2 is valid for the material.

nullable

Optional futurePlndPrice3ValdtyDate

futurePlndPrice3ValdtyDate: Moment

Date from Which Future Planned Price 3 Is Valid. Date as from which planned price 3 is valid for the material.

nullable

Optional inventoryValuationProcedure

inventoryValuationProcedure: undefined | string

Price Control. Indicates the price control used to valuate the stock of a product. You have the following options: · Standard price· Moving average priceIf the material ledger is activated for the product, this indicator, together with the product's price determination indicator, determines at which of the following prices the product is valuated:· Standard price· Moving average price· Periodic unit price. Maximum length: 1.

nullable

Optional isMarkedForDeletion

isMarkedForDeletion: undefined | false | true

Deletion flag for all material data of a valuation type. Indicator which flags all data of a material of a particular valuation type for deletion. The reorganization program checks whether the deletion is allowed and deletes the data if applicable.

nullable

Optional isProducedInhouse

isProducedInhouse: undefined | false | true

Produced in-house. This indicator shows whether the material was produced by the company or another one. It is used for purpose of CFOP determination.If the indicator is set the material was produced by the company. If the indicator is not set the material was produced by another company.

nullable

Optional movingAveragePrice

movingAveragePrice: BigNumber

Moving Average Price/Periodic Unit Price. Price of the material. This can be one of the following: Moving average pricePeriodic unit price (only if the material ledger is activated for the material)The system calculates the moving average price automatically by dividing the material value in the stock account by the total of all storage location stocks in the plant concerned. It changes the price with each valuation-relevant movement.The system changes the periodic unit price if you settle the material ledger and then save the data.The valuation of stocks at moving average price or periodic unit price means that the price of the material is adapted to the continual fluctuations in the procurement price.If the material ledger is activated for the material, the material's settlement control determines whether this price is the moving average price or the periodic unit price.

nullable

Optional plannedPrice

plannedPrice: BigNumber

Future planned price. Price from a marked standard cost estimate. If you create and mark a standard cost estimate for the material, the results of this cost estimate are copied to this field.If you later release the standard cost estimate for this material, the price entered here is updated as the current planned price and as the current standard price.If you do not release the marked standard cost estimate, but create a new one for the material, you can remark the results. You can keep remarking the results until you release the cost estimate.NoteIf no marked standard cost estimate exists, you can enter a price in this field manually. This makes it possible for the system to find a price when costing an assembly via the valuation strategy, even if no standard cost estimate with status KA (correct) exists for a BOM material (such as a raw material or semifinished product).If you subsequently create and flag a cost estimate for this material, the results of this cost estimate are adopted as the future planned price, and the manual entry overwritten. It can then no longer be changed. Therefore, you are recommended to use the Planned price 1, Planned price 2, and Planned price 3 fields to maintain the planned prices of material components and to define them in the valuation strategy.

nullable

Optional plannedPrice1InCoCodeCrcy

plannedPrice1InCoCodeCrcy: BigNumber

Future Planned Price 1. Price that the system can take as a basis for product costing.

nullable

Optional plannedPrice2InCoCodeCrcy

plannedPrice2InCoCodeCrcy: BigNumber

Future Planned Price 2. Price that the system can take as a basis for product costing.

nullable

Optional plannedPrice3InCoCodeCrcy

plannedPrice3InCoCodeCrcy: BigNumber

Future Planned Price 3. Price that the system can take as a basis for product costing.

nullable

Optional prevInvtryPriceInCoCodeCrcy

prevInvtryPriceInCoCodeCrcy: BigNumber

Previous price. Price at which the material was valuated up until the most recent price change. The system makes an entry in this field when you change a price manually in valuation.

nullable

Optional priceDeterminationControl

priceDeterminationControl: undefined | string

Material Price Determination: Control. You have the following options: In Transaction-Based material price determination (option 2 in the material master), with price control V the material is valued at the moving average price. With price control S, the material is valued at the standard price. The moving average price is calculated for information purposes.In Single-/Multilevel price determination (option 3 in the material master), the valuation price (standard price) remains unchanged and a periodic unit price is calculated for the material valuation of the closed period.This option is only possible for materials with price control S (standard price), and is only recommended if, in addition to multiple currencies and/or valuations, you use Single-/Multilevel material price determination.With Single-/Multilevel material price determination, a periodic unit price is updated for information purposes but can only be used for material valuation in the closed period.The indicator is only relevant if the material ledger is active.When you activate the material ledger for a valuation area in Customizing, you can specify what type of material price determination will be proposed when a material is created in that valuation area. This proposal will be ignored at production startup: the system automatically sets the indicator to 2 in the material master for all materials present.If you want to change the indicator for a particular material later, go to the SAP Easy Access menu and choose Accounting > Controlling > Product Cost Controlling > Actual Costing/Material Ledger > Environment > Change Material Price Determination. Maximum length: 1.

nullable

Optional priceLastChangeDate

priceLastChangeDate: Moment

Date of the last price change.

nullable

Optional priceUnitQty

priceUnitQty: BigNumber

Price Unit. Number of units to which the price refers. If 10 gallons of gasoline cost $12.00, the price unit is 10.

nullable

Optional prodCostEstNumber

prodCostEstNumber: undefined | string

Cost Estimate Number - Product Costing. Number that identifies a cost estimate with quantity structure. This number is assigned internally and written to the reference object. Maximum length: 12.

nullable

product

product: string

Material Number. Alphanumeric key uniquely identifying the material. Maximum length: 40.

Optional productOriginType

productOriginType: undefined | string

Origin of the Product. This indicator shows whether the products were produced inside Brazil or were imported. If the goods were imported, it also indicates whether they were imported directly by the company or not. Origin of product:0 National - except indicated for codes 3, 4,5, or 81 Foreign - imported directly2 Foreign - acquired nationally3 National - merchandise or asset with import content is over than 40%4 National - when the production is according to Decree-law 288/67, and laws 8.248/91, 8.387/91, 10.176/01 and 11.484/075 National - with import content less than or equal to 40%6 Foreign - imported directly, no similar national, listed in “Resolução CAMEX”7 Foreign - acquired nationally, no similar national, listed in “Resolução CAMEX”8 National - with import content over 70%. Maximum length: 1.

nullable

Optional productUsageType

productUsageType: undefined | string

Usage of the Product. This indicator shows the intended usage of a particular product in inventory. Please note that each usage of a product must have a separate valuation. As soon as a product has more than one usage in a valuation area then valuation types can be used.Product Usage:0 Resale1 Industrialization2 Consumption3 Asset. Maximum length: 1.

nullable

Optional projectStockValuationClass

projectStockValuationClass: undefined | string

Valuation Class for Project Stock. Default value for the valuation class for valuated project stocks of the material. You need specify a valuation class here only if you want to assign a different valuation class to this type of stock than that assigned to other valuated stocks of the material. This makes it possible to define other allowed G/L accounts for these stocks. Maximum length: 4.

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 standardPrice

standardPrice: BigNumber

Standard price. Standard price of the material The valuation of material stocks at standard prices means that all goods movements are valuated at the same price over an extended period.Price variances (for example, purchase price higher than standard price) upon goods receipt or invoice receipt are posted by the system to price difference accounts. This does not affect the standard price.

nullable

Optional taxBasedPricesPriceUnitQty

taxBasedPricesPriceUnitQty: BigNumber

Price unit for valuation prices based on tax/commercial law. Number of units of measure to which the price related in the previous year. 10 gallons of fuel cost $50.00. In this case, the price unit was 10.

nullable

toMlAccount

toMlAccount: ProductMlAccount[]

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

toMlPrices

toMlPrices: ProductMlPrices[]

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

toValuationAccount

toValuationAccount: ProductValuationAccount

One-to-one navigation property to the ProductValuationAccount entity.

valuationArea

valuationArea: string

Valuation Area. Organizational level at which the material is valuated. A valuation area can be one of the following: PlantAll plants belonging to a company code, in which case the valuation area is the company code. Maximum length: 4.

Optional valuationCategory

valuationCategory: undefined | string

Valuation Category. Determines whether stocks of the material are valuated together or separately. In the case of split valuation, this indicator also determines which valuation types are allowed, that is, the criteria by which stocks can be valuated. Maximum length: 1.

nullable

Optional valuationClass

valuationClass: undefined | string

Valuation Class. Default value for the valuation class for valuated stocks of this material. The valuation class has the following functions:Allows the stock values of materials of the same material type to be posted to different G/L accounts.Allows the stock values of materials of different material types to be posted to the same G/L account.Determines together with other factors the G/L accounts updated for a valuation-relevant transaction (such as a goods movement). Maximum length: 4.

nullable

Optional valuationClassSalesOrderStock

valuationClassSalesOrderStock: undefined | string

Valuation Class for Sales Order Stock. Default value for the valuation class for valuated sales order stocks of the material. You need specify a valuation class here only if you want to assign a different valuation class to this type of stock than that assigned to other valuated stocks of the material. This makes it possible to define other allowed G/L accounts for these stocks. Maximum length: 4.

nullable

valuationType

valuationType: string

Valuation Type. Uniquely identifies separately valuated stocks of a material. The valuation types allowed for a material are determined by the valuation category.If a material is valuated according to its origin (valuation category H), you can define the possible countries of origin as valuation types. Maximum length: 10.

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

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

Static ALL_FIELDS

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

All fields selector.

Static FUTURE_PLND_PRICE_1_VALDTY_DATE

FUTURE_PLND_PRICE_1_VALDTY_DATE: DateField<ProductValuation> = new DateField('FuturePlndPrice1ValdtyDate', ProductValuation, 'Edm.DateTime')

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

Static FUTURE_PLND_PRICE_2_VALDTY_DATE

FUTURE_PLND_PRICE_2_VALDTY_DATE: DateField<ProductValuation> = new DateField('FuturePlndPrice2ValdtyDate', ProductValuation, 'Edm.DateTime')

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

Static FUTURE_PLND_PRICE_3_VALDTY_DATE

FUTURE_PLND_PRICE_3_VALDTY_DATE: DateField<ProductValuation> = new DateField('FuturePlndPrice3ValdtyDate', ProductValuation, 'Edm.DateTime')

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

Static INVENTORY_VALUATION_PROCEDURE

INVENTORY_VALUATION_PROCEDURE: StringField<ProductValuation> = new StringField('InventoryValuationProcedure', ProductValuation, 'Edm.String')

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

Static IS_MARKED_FOR_DELETION

IS_MARKED_FOR_DELETION: BooleanField<ProductValuation> = new BooleanField('IsMarkedForDeletion', ProductValuation, 'Edm.Boolean')

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

Static IS_PRODUCED_INHOUSE

IS_PRODUCED_INHOUSE: BooleanField<ProductValuation> = new BooleanField('IsProducedInhouse', ProductValuation, 'Edm.Boolean')

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

Static MOVING_AVERAGE_PRICE

MOVING_AVERAGE_PRICE: BigNumberField<ProductValuation> = new BigNumberField('MovingAveragePrice', ProductValuation, 'Edm.Decimal')

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

Static PLANNED_PRICE

PLANNED_PRICE: BigNumberField<ProductValuation> = new BigNumberField('PlannedPrice', ProductValuation, 'Edm.Decimal')

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

Static PLANNED_PRICE_1_IN_CO_CODE_CRCY

PLANNED_PRICE_1_IN_CO_CODE_CRCY: BigNumberField<ProductValuation> = new BigNumberField('PlannedPrice1InCoCodeCrcy', ProductValuation, 'Edm.Decimal')

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

Static PLANNED_PRICE_2_IN_CO_CODE_CRCY

PLANNED_PRICE_2_IN_CO_CODE_CRCY: BigNumberField<ProductValuation> = new BigNumberField('PlannedPrice2InCoCodeCrcy', ProductValuation, 'Edm.Decimal')

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

Static PLANNED_PRICE_3_IN_CO_CODE_CRCY

PLANNED_PRICE_3_IN_CO_CODE_CRCY: BigNumberField<ProductValuation> = new BigNumberField('PlannedPrice3InCoCodeCrcy', ProductValuation, 'Edm.Decimal')

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

Static PREV_INVTRY_PRICE_IN_CO_CODE_CRCY

PREV_INVTRY_PRICE_IN_CO_CODE_CRCY: BigNumberField<ProductValuation> = new BigNumberField('PrevInvtryPriceInCoCodeCrcy', ProductValuation, 'Edm.Decimal')

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

Static PRICE_DETERMINATION_CONTROL

PRICE_DETERMINATION_CONTROL: StringField<ProductValuation> = new StringField('PriceDeterminationControl', ProductValuation, 'Edm.String')

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

Static PRICE_LAST_CHANGE_DATE

PRICE_LAST_CHANGE_DATE: DateField<ProductValuation> = new DateField('PriceLastChangeDate', ProductValuation, 'Edm.DateTime')

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

Static PRICE_UNIT_QTY

PRICE_UNIT_QTY: BigNumberField<ProductValuation> = new BigNumberField('PriceUnitQty', ProductValuation, 'Edm.Decimal')

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

Static PRODUCT

PRODUCT: StringField<ProductValuation> = new StringField('Product', ProductValuation, 'Edm.String')

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

Static PRODUCT_ORIGIN_TYPE

PRODUCT_ORIGIN_TYPE: StringField<ProductValuation> = new StringField('ProductOriginType', ProductValuation, 'Edm.String')

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

Static PRODUCT_USAGE_TYPE

PRODUCT_USAGE_TYPE: StringField<ProductValuation> = new StringField('ProductUsageType', ProductValuation, 'Edm.String')

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

Static PROD_COST_EST_NUMBER

PROD_COST_EST_NUMBER: StringField<ProductValuation> = new StringField('ProdCostEstNumber', ProductValuation, 'Edm.String')

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

Static PROJECT_STOCK_VALUATION_CLASS

PROJECT_STOCK_VALUATION_CLASS: StringField<ProductValuation> = new StringField('ProjectStockValuationClass', ProductValuation, 'Edm.String')

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

Static STANDARD_PRICE

STANDARD_PRICE: BigNumberField<ProductValuation> = new BigNumberField('StandardPrice', ProductValuation, 'Edm.Decimal')

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

Static TAX_BASED_PRICES_PRICE_UNIT_QTY

TAX_BASED_PRICES_PRICE_UNIT_QTY: BigNumberField<ProductValuation> = new BigNumberField('TaxBasedPricesPriceUnitQty', ProductValuation, 'Edm.Decimal')

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

Static TO_ML_ACCOUNT

TO_ML_ACCOUNT: Link<ProductValuation, ProductMlAccount> = new Link('to_MLAccount', ProductValuation, ProductMlAccount)

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

Static TO_ML_PRICES

TO_ML_PRICES: Link<ProductValuation, ProductMlPrices> = new Link('to_MLPrices', ProductValuation, ProductMlPrices)

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

Static TO_VALUATION_ACCOUNT

TO_VALUATION_ACCOUNT: OneToOneLink<ProductValuation, ProductValuationAccount> = new OneToOneLink('to_ValuationAccount', ProductValuation, ProductValuationAccount)

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

Static VALUATION_AREA

VALUATION_AREA: StringField<ProductValuation> = new StringField('ValuationArea', ProductValuation, 'Edm.String')

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

Static VALUATION_CATEGORY

VALUATION_CATEGORY: StringField<ProductValuation> = new StringField('ValuationCategory', ProductValuation, 'Edm.String')

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

Static VALUATION_CLASS

VALUATION_CLASS: StringField<ProductValuation> = new StringField('ValuationClass', ProductValuation, 'Edm.String')

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

Static VALUATION_CLASS_SALES_ORDER_STOCK

VALUATION_CLASS_SALES_ORDER_STOCK: StringField<ProductValuation> = new StringField('ValuationClassSalesOrderStock', ProductValuation, 'Edm.String')

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

Static VALUATION_TYPE

VALUATION_TYPE: StringField<ProductValuation> = new StringField('ValuationType', ProductValuation, 'Edm.String')

Static representation of the valuationType 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<ProductValuation> | BigNumberField<ProductValuation> | BooleanField<ProductValuation> | DateField<ProductValuation> | Link<ProductValuation, ProductMlAccount> | Link<ProductValuation, ProductMlPrices> | OneToOneLink<ProductValuation, ProductValuationAccount>> = [ProductValuation.PRODUCT,ProductValuation.VALUATION_AREA,ProductValuation.VALUATION_TYPE,ProductValuation.VALUATION_CLASS,ProductValuation.PRICE_DETERMINATION_CONTROL,ProductValuation.STANDARD_PRICE,ProductValuation.PRICE_UNIT_QTY,ProductValuation.INVENTORY_VALUATION_PROCEDURE,ProductValuation.IS_MARKED_FOR_DELETION,ProductValuation.MOVING_AVERAGE_PRICE,ProductValuation.VALUATION_CATEGORY,ProductValuation.PRODUCT_USAGE_TYPE,ProductValuation.PRODUCT_ORIGIN_TYPE,ProductValuation.IS_PRODUCED_INHOUSE,ProductValuation.PROD_COST_EST_NUMBER,ProductValuation.PROJECT_STOCK_VALUATION_CLASS,ProductValuation.VALUATION_CLASS_SALES_ORDER_STOCK,ProductValuation.PLANNED_PRICE_1_IN_CO_CODE_CRCY,ProductValuation.PLANNED_PRICE_2_IN_CO_CODE_CRCY,ProductValuation.PLANNED_PRICE_3_IN_CO_CODE_CRCY,ProductValuation.FUTURE_PLND_PRICE_1_VALDTY_DATE,ProductValuation.FUTURE_PLND_PRICE_2_VALDTY_DATE,ProductValuation.FUTURE_PLND_PRICE_3_VALDTY_DATE,ProductValuation.TAX_BASED_PRICES_PRICE_UNIT_QTY,ProductValuation.PRICE_LAST_CHANGE_DATE,ProductValuation.PLANNED_PRICE,ProductValuation.PREV_INVTRY_PRICE_IN_CO_CODE_CRCY,ProductValuation.TO_ML_ACCOUNT,ProductValuation.TO_ML_PRICES,ProductValuation.TO_VALUATION_ACCOUNT]

All fields of the ProductValuation entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_ProductValuation"

Technical entity name for ProductValuation.

Static _keyFields

_keyFields: Array<Selectable<ProductValuation>> = [ProductValuation.PRODUCT, ProductValuation.VALUATION_AREA, ProductValuation.VALUATION_TYPE]

All key fields of the ProductValuation entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_PRODUCT_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<ProductValuation>

    A builder that constructs instances of entity type ProductValuation.

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

    Returns ProductValuationRequestBuilder

    A ProductValuation request builder.