Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_Product" of service "API_RAWSUBSTANCE". See https://api.sap.com/api/API_RAWSUBSTANCE for more information.

Hierarchy

  • Entity
    • Product

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns Product

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 adjustmentProfile

adjustmentProfile: string

Adjustment Profile. Maximum length: 3.

nullable

Optional anpCode

anpCode: string

ANP Code. Maximum length: 9.

nullable

Optional baseUnit

baseUnit: string

Base Unit of Measure. Maximum length: 3.

nullable

Optional brand

brand: string

Brand. Maximum length: 4.

nullable

Optional changeNumber

changeNumber: string

Change Number. Maximum length: 12.

nullable

Optional competitorId

competitorId: string

Competitor. Maximum length: 10.

nullable

Optional countryOfOrigin

countryOfOrigin: string

Country of Origin of Material (Non-Preferential Origin). Maximum length: 3.

nullable

Optional createdByUser

createdByUser: string

Name of Person Who Created Object. Maximum length: 12.

nullable

Optional creationDate

creationDate: Moment

Created On.

nullable

Optional crossPlantConfigurableProduct

crossPlantConfigurableProduct: string

Cross-Plant Configurable Product. Maximum length: 40.

nullable

Optional crossPlantStatus

crossPlantStatus: string

Cross-Plant Product Status. Maximum length: 2.

nullable

Optional crossPlantStatusValidityDate

crossPlantStatusValidityDate: Moment

Date from which the cross-plant material status is valid.

nullable

Optional division

division: string

Division. Maximum length: 2.

nullable

Optional externalProductGroup

externalProductGroup: string

External Product Group. Maximum length: 18.

nullable

Optional grossWeight

grossWeight: BigNumber

Gross Weight.

nullable

Optional handlingIndicator

handlingIndicator: string

Handling Indicator. Maximum length: 4.

nullable

Optional handlingUnitType

handlingUnitType: string

Handling Unit Type. Maximum length: 4.

nullable

Optional hasVariableTareWeight

hasVariableTareWeight: boolean

Variable Tare Weight.

nullable

Optional industryStandardName

industryStandardName: string

Industry Standard Description (such as ANSI or ISO). Maximum length: 18.

nullable

Optional internationalArticleNumberCat

internationalArticleNumberCat: string

Category of International Article Number (EAN). Maximum length: 2.

nullable

Optional isBatchManagementRequired

isBatchManagementRequired: boolean

Batch management requirement indicator.

nullable

Optional isMarkedForDeletion

isMarkedForDeletion: boolean

Flag Material for Deletion at Client Level.

nullable

Optional isPilferable

isPilferable: boolean

Pilferable.

nullable

Optional isRelevantForHzdsSubstances

isRelevantForHzdsSubstances: boolean

Relevant for Hazardous Substances.

nullable

Optional itemCategoryGroup

itemCategoryGroup: string

General item category group. Maximum length: 4.

nullable

Optional lastChangeDate

lastChangeDate: Moment

Date of Last Change.

nullable

Optional lastChangedByUser

lastChangedByUser: string

Name of Person who Changed Object. Maximum length: 12.

nullable

Optional lowLevelCode

lowLevelCode: string

Low-Level Code. Maximum length: 3.

nullable

Optional manufacturerPartProfile

manufacturerPartProfile: string

Manufacturer Part Profile. Maximum length: 4.

nullable

Optional materialRevisionLevel

materialRevisionLevel: string

Revision Level. Maximum length: 2.

nullable

Optional materialVolume

materialVolume: BigNumber

Volume.

nullable

Optional maximumPackagingHeight

maximumPackagingHeight: BigNumber

Maximum Packing Height of Packaging Material.

nullable

Optional maximumPackagingLength

maximumPackagingLength: BigNumber

Maximum Packing Length of Packaging Material.

nullable

Optional maximumPackagingWidth

maximumPackagingWidth: BigNumber

Maximum Packing Width of Packaging Material.

nullable

Optional netWeight

netWeight: BigNumber

Net Weight.

nullable

Optional preferredUnitOfMeasure

preferredUnitOfMeasure: string

Preferred Alternative UoM for Warehouse Operations. Maximum length: 3.

nullable

Optional procurementRule

procurementRule: string

Procurement rule. Maximum length: 1.

nullable

Optional prodNoInGenProdInPrepackProd

prodNoInGenProdInPrepackProd: string

Material Number of the Generic Material in Prepack Materials. Maximum length: 40.

nullable

product

product: string

Product Number. Maximum length: 40.

Optional productGroup

productGroup: string

Product Group. Maximum length: 9.

nullable

Optional productHierarchy

productHierarchy: string

Product Hierarchy. Maximum length: 18.

nullable

Optional productIsConfigurable

productIsConfigurable: boolean

Configurable Material.

nullable

Optional productManufacturerNumber

productManufacturerNumber: string

Manufacturer Part Number. Maximum length: 40.

nullable

Optional productOldId

productOldId: string

Old Product Number. Maximum length: 40.

nullable

Optional productStandardId

productStandardId: string

The global trade item number (EAN/UPC/GTIN). Maximum length: 18.

nullable

Optional productType

productType: string

Product Type. Maximum length: 4.

nullable

Optional purchaseOrderQuantityUnit

purchaseOrderQuantityUnit: string

Purchase Order Unit of Measure. Maximum length: 3.

nullable

Optional qualityInspectionGroup

qualityInspectionGroup: string

Quality Inspection Group. Maximum length: 4.

nullable

Optional quarantinePeriod

quarantinePeriod: BigNumber

Quarantine Period.

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 serialIdentifierAssgmtProfile

serialIdentifierAssgmtProfile: string

Serial Number Profile. Maximum length: 4.

nullable

Optional serialNoExplicitnessLevel

serialNoExplicitnessLevel: string

Level of Explicitness for Serial Number. Maximum length: 1.

nullable

Optional serialNumberProfile

serialNumberProfile: string

Serial Number Profile. Maximum length: 4.

nullable

Optional sizeOrDimensionText

sizeOrDimensionText: string

Size/dimensions. Maximum length: 32.

nullable

Optional sourceOfSupply

sourceOfSupply: string

Source of Supply. Maximum length: 1.

nullable

Optional standardHandlingUnitType

standardHandlingUnitType: string

Standard HU Type. Maximum length: 4.

nullable

Optional timeUnitForQuarantinePeriod

timeUnitForQuarantinePeriod: string

Time Unit for Quarantine Period. Maximum length: 3.

nullable

toDescription

toDescription: ProductDescription[]

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

toPlant

toPlant: ProductPlant[]

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

toSalesDelivery

toSalesDelivery: ProductSalesDelivery[]

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

Optional validityStartDate

validityStartDate: Moment

Valid-From Date.

nullable

Optional varblPurOrdUnitIsActive

varblPurOrdUnitIsActive: string

Variable Purchase Order Unit Active. Maximum length: 1.

nullable

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

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

Optional volumeUnit

volumeUnit: string

Volume Unit. Maximum length: 3.

nullable

Optional warehouseProductGroup

warehouseProductGroup: string

Warehouse Material Group. Maximum length: 4.

nullable

Optional warehouseStorageCondition

warehouseStorageCondition: string

Warehouse Storage Condition. Maximum length: 2.

nullable

Optional weightUnit

weightUnit: string

Unit of Weight. Maximum length: 3.

nullable

Static ADJUSTMENT_PROFILE

ADJUSTMENT_PROFILE: StringField<Product> = new StringField('AdjustmentProfile', Product, 'Edm.String')

Static representation of the adjustmentProfile 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<Product> = new AllFields('*', Product)

All fields selector.

Static ANP_CODE

ANP_CODE: StringField<Product> = new StringField('ANPCode', Product, 'Edm.String')

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

Static BASE_UNIT

BASE_UNIT: StringField<Product> = new StringField('BaseUnit', Product, 'Edm.String')

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

Static BRAND

BRAND: StringField<Product> = new StringField('Brand', Product, 'Edm.String')

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

Static CHANGE_NUMBER

CHANGE_NUMBER: StringField<Product> = new StringField('ChangeNumber', Product, 'Edm.String')

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

Static COMPETITOR_ID

COMPETITOR_ID: StringField<Product> = new StringField('CompetitorID', Product, 'Edm.String')

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

Static COUNTRY_OF_ORIGIN

COUNTRY_OF_ORIGIN: StringField<Product> = new StringField('CountryOfOrigin', Product, 'Edm.String')

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

Static CREATED_BY_USER

CREATED_BY_USER: StringField<Product> = new StringField('CreatedByUser', Product, 'Edm.String')

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

Static CREATION_DATE

CREATION_DATE: DateField<Product> = new DateField('CreationDate', Product, 'Edm.DateTime')

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

Static CROSS_PLANT_CONFIGURABLE_PRODUCT

CROSS_PLANT_CONFIGURABLE_PRODUCT: StringField<Product> = new StringField('CrossPlantConfigurableProduct', Product, 'Edm.String')

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

Static CROSS_PLANT_STATUS

CROSS_PLANT_STATUS: StringField<Product> = new StringField('CrossPlantStatus', Product, 'Edm.String')

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

Static CROSS_PLANT_STATUS_VALIDITY_DATE

CROSS_PLANT_STATUS_VALIDITY_DATE: DateField<Product> = new DateField('CrossPlantStatusValidityDate', Product, 'Edm.DateTime')

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

Static DIVISION

DIVISION: StringField<Product> = new StringField('Division', Product, 'Edm.String')

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

Static EXTERNAL_PRODUCT_GROUP

EXTERNAL_PRODUCT_GROUP: StringField<Product> = new StringField('ExternalProductGroup', Product, 'Edm.String')

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

Static GROSS_WEIGHT

GROSS_WEIGHT: BigNumberField<Product> = new BigNumberField('GrossWeight', Product, 'Edm.Decimal')

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

Static HANDLING_INDICATOR

HANDLING_INDICATOR: StringField<Product> = new StringField('HandlingIndicator', Product, 'Edm.String')

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

Static HANDLING_UNIT_TYPE

HANDLING_UNIT_TYPE: StringField<Product> = new StringField('HandlingUnitType', Product, 'Edm.String')

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

Static HAS_VARIABLE_TARE_WEIGHT

HAS_VARIABLE_TARE_WEIGHT: BooleanField<Product> = new BooleanField('HasVariableTareWeight', Product, 'Edm.Boolean')

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

Static INDUSTRY_STANDARD_NAME

INDUSTRY_STANDARD_NAME: StringField<Product> = new StringField('IndustryStandardName', Product, 'Edm.String')

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

Static INTERNATIONAL_ARTICLE_NUMBER_CAT

INTERNATIONAL_ARTICLE_NUMBER_CAT: StringField<Product> = new StringField('InternationalArticleNumberCat', Product, 'Edm.String')

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

Static IS_BATCH_MANAGEMENT_REQUIRED

IS_BATCH_MANAGEMENT_REQUIRED: BooleanField<Product> = new BooleanField('IsBatchManagementRequired', Product, 'Edm.Boolean')

Static representation of the isBatchManagementRequired 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<Product> = new BooleanField('IsMarkedForDeletion', Product, '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_PILFERABLE

IS_PILFERABLE: BooleanField<Product> = new BooleanField('IsPilferable', Product, 'Edm.Boolean')

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

Static IS_RELEVANT_FOR_HZDS_SUBSTANCES

IS_RELEVANT_FOR_HZDS_SUBSTANCES: BooleanField<Product> = new BooleanField('IsRelevantForHzdsSubstances', Product, 'Edm.Boolean')

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

Static ITEM_CATEGORY_GROUP

ITEM_CATEGORY_GROUP: StringField<Product> = new StringField('ItemCategoryGroup', Product, 'Edm.String')

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

Static LAST_CHANGED_BY_USER

LAST_CHANGED_BY_USER: StringField<Product> = new StringField('LastChangedByUser', Product, 'Edm.String')

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

Static LAST_CHANGE_DATE

LAST_CHANGE_DATE: DateField<Product> = new DateField('LastChangeDate', Product, 'Edm.DateTime')

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

Static LOW_LEVEL_CODE

LOW_LEVEL_CODE: StringField<Product> = new StringField('LowLevelCode', Product, 'Edm.String')

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

Static MANUFACTURER_PART_PROFILE

MANUFACTURER_PART_PROFILE: StringField<Product> = new StringField('ManufacturerPartProfile', Product, 'Edm.String')

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

Static MATERIAL_REVISION_LEVEL

MATERIAL_REVISION_LEVEL: StringField<Product> = new StringField('MaterialRevisionLevel', Product, 'Edm.String')

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

Static MATERIAL_VOLUME

MATERIAL_VOLUME: BigNumberField<Product> = new BigNumberField('MaterialVolume', Product, 'Edm.Decimal')

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

Static MAXIMUM_PACKAGING_HEIGHT

MAXIMUM_PACKAGING_HEIGHT: BigNumberField<Product> = new BigNumberField('MaximumPackagingHeight', Product, 'Edm.Decimal')

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

Static MAXIMUM_PACKAGING_LENGTH

MAXIMUM_PACKAGING_LENGTH: BigNumberField<Product> = new BigNumberField('MaximumPackagingLength', Product, 'Edm.Decimal')

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

Static MAXIMUM_PACKAGING_WIDTH

MAXIMUM_PACKAGING_WIDTH: BigNumberField<Product> = new BigNumberField('MaximumPackagingWidth', Product, 'Edm.Decimal')

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

Static NET_WEIGHT

NET_WEIGHT: BigNumberField<Product> = new BigNumberField('NetWeight', Product, 'Edm.Decimal')

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

Static PREFERRED_UNIT_OF_MEASURE

PREFERRED_UNIT_OF_MEASURE: StringField<Product> = new StringField('PreferredUnitOfMeasure', Product, 'Edm.String')

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

Static PROCUREMENT_RULE

PROCUREMENT_RULE: StringField<Product> = new StringField('ProcurementRule', Product, 'Edm.String')

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

Static PRODUCT

PRODUCT: StringField<Product> = new StringField('Product', Product, '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_GROUP

PRODUCT_GROUP: StringField<Product> = new StringField('ProductGroup', Product, 'Edm.String')

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

Static PRODUCT_HIERARCHY

PRODUCT_HIERARCHY: StringField<Product> = new StringField('ProductHierarchy', Product, 'Edm.String')

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

Static PRODUCT_IS_CONFIGURABLE

PRODUCT_IS_CONFIGURABLE: BooleanField<Product> = new BooleanField('ProductIsConfigurable', Product, 'Edm.Boolean')

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

Static PRODUCT_MANUFACTURER_NUMBER

PRODUCT_MANUFACTURER_NUMBER: StringField<Product> = new StringField('ProductManufacturerNumber', Product, 'Edm.String')

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

Static PRODUCT_OLD_ID

PRODUCT_OLD_ID: StringField<Product> = new StringField('ProductOldID', Product, 'Edm.String')

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

Static PRODUCT_STANDARD_ID

PRODUCT_STANDARD_ID: StringField<Product> = new StringField('ProductStandardID', Product, 'Edm.String')

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

Static PRODUCT_TYPE

PRODUCT_TYPE: StringField<Product> = new StringField('ProductType', Product, 'Edm.String')

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

Static PROD_NO_IN_GEN_PROD_IN_PREPACK_PROD

PROD_NO_IN_GEN_PROD_IN_PREPACK_PROD: StringField<Product> = new StringField('ProdNoInGenProdInPrepackProd', Product, 'Edm.String')

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

Static PURCHASE_ORDER_QUANTITY_UNIT

PURCHASE_ORDER_QUANTITY_UNIT: StringField<Product> = new StringField('PurchaseOrderQuantityUnit', Product, 'Edm.String')

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

Static QUALITY_INSPECTION_GROUP

QUALITY_INSPECTION_GROUP: StringField<Product> = new StringField('QualityInspectionGroup', Product, 'Edm.String')

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

Static QUARANTINE_PERIOD

QUARANTINE_PERIOD: BigNumberField<Product> = new BigNumberField('QuarantinePeriod', Product, 'Edm.Decimal')

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

Static SERIAL_IDENTIFIER_ASSGMT_PROFILE

SERIAL_IDENTIFIER_ASSGMT_PROFILE: StringField<Product> = new StringField('SerialIdentifierAssgmtProfile', Product, 'Edm.String')

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

Static SERIAL_NO_EXPLICITNESS_LEVEL

SERIAL_NO_EXPLICITNESS_LEVEL: StringField<Product> = new StringField('SerialNoExplicitnessLevel', Product, 'Edm.String')

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

Static SERIAL_NUMBER_PROFILE

SERIAL_NUMBER_PROFILE: StringField<Product> = new StringField('SerialNumberProfile', Product, 'Edm.String')

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

Static SIZE_OR_DIMENSION_TEXT

SIZE_OR_DIMENSION_TEXT: StringField<Product> = new StringField('SizeOrDimensionText', Product, 'Edm.String')

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

Static SOURCE_OF_SUPPLY

SOURCE_OF_SUPPLY: StringField<Product> = new StringField('SourceOfSupply', Product, 'Edm.String')

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

Static STANDARD_HANDLING_UNIT_TYPE

STANDARD_HANDLING_UNIT_TYPE: StringField<Product> = new StringField('StandardHandlingUnitType', Product, 'Edm.String')

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

Static TIME_UNIT_FOR_QUARANTINE_PERIOD

TIME_UNIT_FOR_QUARANTINE_PERIOD: StringField<Product> = new StringField('TimeUnitForQuarantinePeriod', Product, 'Edm.String')

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

Static TO_DESCRIPTION

TO_DESCRIPTION: Link<Product, ProductDescription> = new Link('to_Description', Product, ProductDescription)

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

Static TO_PLANT

TO_PLANT: Link<Product, ProductPlant> = new Link('to_Plant', Product, ProductPlant)

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

Static TO_SALES_DELIVERY

TO_SALES_DELIVERY: Link<Product, ProductSalesDelivery> = new Link('to_SalesDelivery', Product, ProductSalesDelivery)

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

Static VALIDITY_START_DATE

VALIDITY_START_DATE: DateField<Product> = new DateField('ValidityStartDate', Product, 'Edm.DateTime')

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

Static VARBL_PUR_ORD_UNIT_IS_ACTIVE

VARBL_PUR_ORD_UNIT_IS_ACTIVE: StringField<Product> = new StringField('VarblPurOrdUnitIsActive', Product, 'Edm.String')

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

Static VOLUME_UNIT

VOLUME_UNIT: StringField<Product> = new StringField('VolumeUnit', Product, 'Edm.String')

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

Static WAREHOUSE_PRODUCT_GROUP

WAREHOUSE_PRODUCT_GROUP: StringField<Product> = new StringField('WarehouseProductGroup', Product, 'Edm.String')

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

Static WAREHOUSE_STORAGE_CONDITION

WAREHOUSE_STORAGE_CONDITION: StringField<Product> = new StringField('WarehouseStorageCondition', Product, 'Edm.String')

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

Static WEIGHT_UNIT

WEIGHT_UNIT: StringField<Product> = new StringField('WeightUnit', Product, 'Edm.String')

Static representation of the weightUnit 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<Product> | BigNumberField<Product> | DateField<Product> | BooleanField<Product> | Link<Product, ProductDescription> | Link<Product, ProductPlant> | Link<Product, ProductSalesDelivery>> = [Product.PRODUCT,Product.PRODUCT_OLD_ID,Product.GROSS_WEIGHT,Product.PURCHASE_ORDER_QUANTITY_UNIT,Product.SOURCE_OF_SUPPLY,Product.WEIGHT_UNIT,Product.NET_WEIGHT,Product.COUNTRY_OF_ORIGIN,Product.COMPETITOR_ID,Product.PRODUCT_GROUP,Product.BASE_UNIT,Product.PRODUCT_TYPE,Product.ITEM_CATEGORY_GROUP,Product.PRODUCT_HIERARCHY,Product.DIVISION,Product.VARBL_PUR_ORD_UNIT_IS_ACTIVE,Product.VOLUME_UNIT,Product.MATERIAL_VOLUME,Product.ANP_CODE,Product.BRAND,Product.PROCUREMENT_RULE,Product.VALIDITY_START_DATE,Product.CROSS_PLANT_STATUS,Product.LOW_LEVEL_CODE,Product.PROD_NO_IN_GEN_PROD_IN_PREPACK_PROD,Product.SERIAL_IDENTIFIER_ASSGMT_PROFILE,Product.SIZE_OR_DIMENSION_TEXT,Product.INDUSTRY_STANDARD_NAME,Product.PRODUCT_STANDARD_ID,Product.INTERNATIONAL_ARTICLE_NUMBER_CAT,Product.PRODUCT_IS_CONFIGURABLE,Product.IS_BATCH_MANAGEMENT_REQUIRED,Product.EXTERNAL_PRODUCT_GROUP,Product.CROSS_PLANT_STATUS_VALIDITY_DATE,Product.CROSS_PLANT_CONFIGURABLE_PRODUCT,Product.SERIAL_NO_EXPLICITNESS_LEVEL,Product.PRODUCT_MANUFACTURER_NUMBER,Product.MANUFACTURER_PART_PROFILE,Product.CHANGE_NUMBER,Product.MATERIAL_REVISION_LEVEL,Product.HANDLING_INDICATOR,Product.WAREHOUSE_PRODUCT_GROUP,Product.WAREHOUSE_STORAGE_CONDITION,Product.STANDARD_HANDLING_UNIT_TYPE,Product.CREATION_DATE,Product.SERIAL_NUMBER_PROFILE,Product.ADJUSTMENT_PROFILE,Product.PREFERRED_UNIT_OF_MEASURE,Product.IS_PILFERABLE,Product.IS_RELEVANT_FOR_HZDS_SUBSTANCES,Product.QUARANTINE_PERIOD,Product.TIME_UNIT_FOR_QUARANTINE_PERIOD,Product.QUALITY_INSPECTION_GROUP,Product.HANDLING_UNIT_TYPE,Product.HAS_VARIABLE_TARE_WEIGHT,Product.CREATED_BY_USER,Product.MAXIMUM_PACKAGING_LENGTH,Product.MAXIMUM_PACKAGING_WIDTH,Product.MAXIMUM_PACKAGING_HEIGHT,Product.LAST_CHANGE_DATE,Product.LAST_CHANGED_BY_USER,Product.IS_MARKED_FOR_DELETION,Product.TO_DESCRIPTION,Product.TO_PLANT,Product.TO_SALES_DELIVERY]

All fields of the Product entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_Product"

Technical entity name for Product.

Static _keyFields

_keyFields: Array<Selectable<Product>> = [Product.PRODUCT]

All key fields of the Product entity.

Static _keys

_keys: any = Product._keyFields.reduce((acc: any, field) => {acc[field.fieldName] = field;return acc;}, {})

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

Static _serviceName

_serviceName: string = "API_RAWSUBSTANCE"
deprecated

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

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.

    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): this
  • Set the ETag version identifier of the retrieved entity.

    Parameters

    • etag: string

      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

  • Returns an entity builder to construct instances Product.

    Returns EntityBuilderType<Product, ProductType>

    A builder that constructs instances of entity type Product.

Static customField

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<Product>

    A builder that constructs instances of entity type Product.

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, JsonT>(entityConstructor: Constructable<EntityT>): EntityBuilderType<EntityT, JsonT>
  • Type parameters

    • EntityT: Entity

    • JsonT

    Parameters

    • entityConstructor: Constructable<EntityT>

    Returns EntityBuilderType<EntityT, JsonT>

Static requestBuilder

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

    Returns ProductRequestBuilder

    A Product request builder.