Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_ProductSupplyPlanning" 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
    • ProductSupplyPlanning

Implements

Index

Constructors

constructor

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 abcIndicator

abcIndicator: string

ABC Indicator. Indicator that classifies a material as an A, B, or C part according to its consumption value. This classification process is known as the ABC analysis. The three indicators have the following meanings:A - important part, high consumption valueB - less important part, medium consumption valueC - relatively unimportant part, low consumption value. Maximum length: 1.

nullable

Optional assemblyScrapPercent

assemblyScrapPercent: BigNumber

Assembly scrap in percent. Percentage scrap that occurs during production of the material if the material is an assembly. The assembly scrap is used in materials planning to calculate the lot size of the assembly. The system increases the quantity to be produced by the scrap quantity calculated.If the material is an assembly, specify the percentage scrap as required.If the quantity to be produced is 200 pieces and you specify an assembly scrap of 10%, you are reckoning with a scrap quantity of 20 pieces. As a result, 220 pieces are produced.The system increases the quantity to be produced for all of the assembly's components accordingly.

nullable

Optional availabilityCheckType

availabilityCheckType: string

Checking Group for Availability Check. This field has two uses: Specifies whether and how the system checks availability and generates requirements for materials planning.In Flexible Planning, defines - together with the checking rule - the different MRP elements that make up this key figure. The sum of these elements gives the key figure.Use 1: Availability Checking and Materials PlanningThe value you enter for use 1 (see above) is a default value which defines:Which MRP elements (for example, purchase orders, reservations) the system includes in the availability checkWhether the system checks availability only until the end of the replenishment lead time or whether it checks availability over the entire period for which MRP elements existWhether the system generates individual requirements or summarized requirements if you enter sales orders or deliveries for the materialUse 2: Flexible PlanningIf you use this field to define the MRP elements of a key figure for Flexible Planning, you must also select Document KF in the Customizing parameters of the information structure. Maximum length: 2.

nullable

Optional fixedLotSizeQuantity

fixedLotSizeQuantity: BigNumber

Fixed lot size. Quantity that will be ordered or produced in the event of a shortage. If the amount of the shortage is less than the fixed lot size, it is the fixed lot size that is ordered or produced (and not the lesser quantity that is actually required).If the amount of the shortage is greater than the fixed lot size, a multiple of the fixed lot size is procured. The system creates several purchase order proposals for this purpose.

nullable

Optional goodsReceiptDuration

goodsReceiptDuration: BigNumber

Goods Receipt Processing Time in Days. Number of workdays required after receiving the material for inspection and placement into storage.

nullable

Optional lotSizeRoundingQuantity

lotSizeRoundingQuantity: BigNumber

Rounding value for purchase order quantity. Value to a multiple of which the system rounds up the procurement quantity. The rounding value is used in the planning run if no rounding profile has been specified in the material master record.

nullable

Optional lotSizingProcedure

lotSizingProcedure: string

Lot Sizing Procedure within Materials Planning. Key that determines which lot-sizing procedure the system uses within materials planning to calculate the quantity to be procured or produced. Maximum length: 2.

nullable

Optional maximumLotSizeQuantity

maximumLotSizeQuantity: BigNumber

Maximum Lot Size. Quantity that is not allowed to be exceeded during procurement. The system takes this value into account during the automatic lot size calculation for planned orders and production orders. The lot size of the individual orders cannot exceed this value.

nullable

Optional maximumStockQuantity

maximumStockQuantity: BigNumber

Maximum Stock Level. Quantity of the material in this plant that may not be exceeded. In materials planning, the maximum stock level is used only if you have chosen Replenish to maximum stock level as the lot-sizing procedure; that is, you have entered HB as the lot size key.Enter a value if you have chosen Replenish to maximum stock level as the lot-sizing procedure.

nullable

Optional minimumLotSizeQuantity

minimumLotSizeQuantity: BigNumber

Minimum Lot Size. Minimum procurement quantity.

nullable

Optional minimumSafetyStockQuantity

minimumSafetyStockQuantity: BigNumber

Minimum Safety Stock. The quantity that defines the lower limit for safety stock. This value cannot be exceeded. Defining a lower limit can influence the following:material master data maintenanceThe safety is checked to see if it is greater or equal to this lower limit.forecastingThe lower limit is checked if you use an availability indicator which shows if the safety stock is to be calculated again in a forecast.If the safety stock is lower than this level in forecasting, the safety stock is automatically increased to the value of the lower level.The safety stock must always be greater or equal to this lower level.

nullable

Optional mrpGroup

mrpGroup: string

MRP Group. The MRP group contains all the materials from the point of view of MRP for assigning special control parameters for the total planning run. These control parameters include, for example, the strategy group, the consumption mode, and the planning horizon. Maximum length: 4.

nullable

Optional mrpResponsible

mrpResponsible: string

MRP Controller. Specifies the number of the MRP controller or group of MRP controllers responsible for material planning for the material. Maximum length: 3.

nullable

Optional mrpType

mrpType: string

MRP Type. Key that determines whether and how the material is planned. You have the following options: Manual reorder point planningAutomatic reorder point planningForecast-based planningMaterial requirements planning with forecasts for unplanned consumptionMaster production scheduling (MPS)Demand-driven replenishment. Maximum length: 2.

nullable

Optional plannedDeliveryDurationInDays

plannedDeliveryDurationInDays: BigNumber

Planned Delivery Time in Days. Number of calendar days needed to obtain the material or service if it is procured externally. If you have different vendors for a material, you must specify an average value. The same applies if you order the material from a fixed vendor that has varying delivery times.If you use the SAP Retail System, the planned delivery time can be suggested from the vendor sub-range in the vendor master record.

nullable

Optional planningStrategyGroup

planningStrategyGroup: string

Planning Strategy Group. The strategy group groups all the planning strategies that can be used for a particular material. The planning strategy represents the procedure used for planning a material and is (technically speaking) controlled by the MRP types. Maximum length: 2.

nullable

Optional planningTimeFence

planningTimeFence: string

Planning time fence. The planning time fence specifies a period within which no automatic changes are to be made to the master plan. The planning time fence is maintained in workdays.It is only used for materials that are planned using an MRP type which includes a firming type.The firming type determines how order proposlas are to be created or scheduled within the planning time fence. Maximum length: 3.

nullable

plant

plant: string

Plant. Key uniquely identifying a plant. Maximum length: 4.

Optional procurementSubType

procurementSubType: string

Special procurement type. Allows you to define the procurement type more exactly. The system determines the procurement type from the material type. You use special procurement when you want to be able to override the procurement type in the material master or define the procurement type more precisely.If the procurement type is in-house, you can nevertheless force the system to ignore the BOM and routing, and process the material as if it were externally procured, by specifying the special procurement as external.Enter the special procurement type to which you want to restrict the selection.If you procure a material externally, you may want to choose the special procurement type Consignment. If you produce the material in-house, it may be appropriate to choose Production in other plant.If a material has a routing but no BOM, it is treated as an externally procured material even if the procurement type is in-house. Both the BOM and the routing are ignored.However, if you specify the special procurement type as in-house, the routing is included even if the material has no BOM. Maximum length: 2.

nullable

Optional procurementType

procurementType: string

Procurement Type. Indicator that defines how the material is procured. The following procurements types are possible: The material is produced in-house.The material is procured externally.The material can be both produced in-house and procured externally. Maximum length: 1.

nullable

product

product: string

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

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 reorderThresholdQuantity

reorderThresholdQuantity: BigNumber

Reorder Point. If the stock falls below this quantity, the system flags the material for requirements planning by creating a planning file entry.

nullable

Optional safetyDuration

safetyDuration: string

Safety time (in workdays). In this field, you define the number of workdays for the safety time/actual range of coverage. If you define a safety time, the requirements in MRP are brought forward on the time axis by the number of workdays you define here.This does not change the actual requirements dates. However, as the requirements have technically been brought forward, receipts are created for the earlier dates in MRP.Time-phased materials planning is based on the interval between the MRP date and the availabilty date of the next MRP date. By using the safety time/ actual range of coverage, the number of days to the interval are included in the calculation. Maximum length: 2.

nullable

Optional safetyStockQuantity

safetyStockQuantity: BigNumber

Safety Stock. Specifies the quantity whose purpose is to satisfy unexpectedly high demand in the coverage period. The risk of shortfalls is reduced by having a safety stock.

nullable

Optional totalReplenishmentLeadTime

totalReplenishmentLeadTime: BigNumber

Total replenishment lead time (in workdays). The total replenishment lead time is the time needed before the product is completely available again, that is, after all BOM levels have been procured or produced. It is not calculated by the system, but defined in this field as the total of the in-house production time(s) and/or the planned delivery time(s) of the longest production path. This time is necessary if, for materials produced in-house, the replenishment lead time is to be taken into consideration in the availability check.In an availability check where the system takes the replenishment lead time into consideration, it only checks whether there are sufficient incoming quantities and stocks available to cover the requirements within the replenishment lead time. Outside the replenishment lead time,the system assumes that the material is available in sufficient quantity.Therefore, in this situation, it is usually necessary to depict the product's total replenishment lead time with all BOM levels as the replenishment lead time.The following options exist for materials produced in-house if the replenishment lead time is included in the availability check:The Total replenishment lead time field is maintained.In this case, the time maintained in this field is used for the availability check.The Total replenishment lead time field is not maintained.In this case, the system reads the in-house production time and, if available, the goods receipt processing time, and interprets the total of these two times as the replenishment lead time for the availability check.There is no point in maintaining the Total replenishment lead time field for materials procured externally. In external procurement, the system adds the processing time from purchasing, the planned delivery time, and the goods receipt processing time and uses this total as the replenishment lead time for an availability check with replenishment lead time.

nullable

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

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

Static ABC_INDICATOR

ABC_INDICATOR: StringField<ProductSupplyPlanning> = new StringField('ABCIndicator', ProductSupplyPlanning, 'Edm.String')

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

All fields selector.

Static ASSEMBLY_SCRAP_PERCENT

ASSEMBLY_SCRAP_PERCENT: BigNumberField<ProductSupplyPlanning> = new BigNumberField('AssemblyScrapPercent', ProductSupplyPlanning, 'Edm.Decimal')

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

Static AVAILABILITY_CHECK_TYPE

AVAILABILITY_CHECK_TYPE: StringField<ProductSupplyPlanning> = new StringField('AvailabilityCheckType', ProductSupplyPlanning, 'Edm.String')

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

Static FIXED_LOT_SIZE_QUANTITY

FIXED_LOT_SIZE_QUANTITY: BigNumberField<ProductSupplyPlanning> = new BigNumberField('FixedLotSizeQuantity', ProductSupplyPlanning, 'Edm.Decimal')

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

Static GOODS_RECEIPT_DURATION

GOODS_RECEIPT_DURATION: BigNumberField<ProductSupplyPlanning> = new BigNumberField('GoodsReceiptDuration', ProductSupplyPlanning, 'Edm.Decimal')

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

Static LOT_SIZE_ROUNDING_QUANTITY

LOT_SIZE_ROUNDING_QUANTITY: BigNumberField<ProductSupplyPlanning> = new BigNumberField('LotSizeRoundingQuantity', ProductSupplyPlanning, 'Edm.Decimal')

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

Static LOT_SIZING_PROCEDURE

LOT_SIZING_PROCEDURE: StringField<ProductSupplyPlanning> = new StringField('LotSizingProcedure', ProductSupplyPlanning, 'Edm.String')

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

Static MAXIMUM_LOT_SIZE_QUANTITY

MAXIMUM_LOT_SIZE_QUANTITY: BigNumberField<ProductSupplyPlanning> = new BigNumberField('MaximumLotSizeQuantity', ProductSupplyPlanning, 'Edm.Decimal')

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

Static MAXIMUM_STOCK_QUANTITY

MAXIMUM_STOCK_QUANTITY: BigNumberField<ProductSupplyPlanning> = new BigNumberField('MaximumStockQuantity', ProductSupplyPlanning, 'Edm.Decimal')

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

Static MINIMUM_LOT_SIZE_QUANTITY

MINIMUM_LOT_SIZE_QUANTITY: BigNumberField<ProductSupplyPlanning> = new BigNumberField('MinimumLotSizeQuantity', ProductSupplyPlanning, 'Edm.Decimal')

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

Static MINIMUM_SAFETY_STOCK_QUANTITY

MINIMUM_SAFETY_STOCK_QUANTITY: BigNumberField<ProductSupplyPlanning> = new BigNumberField('MinimumSafetyStockQuantity', ProductSupplyPlanning, 'Edm.Decimal')

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

Static MRP_GROUP

MRP_GROUP: StringField<ProductSupplyPlanning> = new StringField('MRPGroup', ProductSupplyPlanning, 'Edm.String')

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

Static MRP_RESPONSIBLE

MRP_RESPONSIBLE: StringField<ProductSupplyPlanning> = new StringField('MRPResponsible', ProductSupplyPlanning, 'Edm.String')

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

Static MRP_TYPE

MRP_TYPE: StringField<ProductSupplyPlanning> = new StringField('MRPType', ProductSupplyPlanning, 'Edm.String')

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

Static PLANNED_DELIVERY_DURATION_IN_DAYS

PLANNED_DELIVERY_DURATION_IN_DAYS: BigNumberField<ProductSupplyPlanning> = new BigNumberField('PlannedDeliveryDurationInDays', ProductSupplyPlanning, 'Edm.Decimal')

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

Static PLANNING_STRATEGY_GROUP

PLANNING_STRATEGY_GROUP: StringField<ProductSupplyPlanning> = new StringField('PlanningStrategyGroup', ProductSupplyPlanning, 'Edm.String')

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

Static PLANNING_TIME_FENCE

PLANNING_TIME_FENCE: StringField<ProductSupplyPlanning> = new StringField('PlanningTimeFence', ProductSupplyPlanning, 'Edm.String')

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

Static PLANT

PLANT: StringField<ProductSupplyPlanning> = new StringField('Plant', ProductSupplyPlanning, 'Edm.String')

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

Static PROCUREMENT_SUB_TYPE

PROCUREMENT_SUB_TYPE: StringField<ProductSupplyPlanning> = new StringField('ProcurementSubType', ProductSupplyPlanning, 'Edm.String')

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

Static PROCUREMENT_TYPE

PROCUREMENT_TYPE: StringField<ProductSupplyPlanning> = new StringField('ProcurementType', ProductSupplyPlanning, 'Edm.String')

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

Static PRODUCT

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

REORDER_THRESHOLD_QUANTITY: BigNumberField<ProductSupplyPlanning> = new BigNumberField('ReorderThresholdQuantity', ProductSupplyPlanning, 'Edm.Decimal')

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

Static SAFETY_DURATION

SAFETY_DURATION: StringField<ProductSupplyPlanning> = new StringField('SafetyDuration', ProductSupplyPlanning, 'Edm.String')

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

Static SAFETY_STOCK_QUANTITY

SAFETY_STOCK_QUANTITY: BigNumberField<ProductSupplyPlanning> = new BigNumberField('SafetyStockQuantity', ProductSupplyPlanning, 'Edm.Decimal')

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

Static TOTAL_REPLENISHMENT_LEAD_TIME

TOTAL_REPLENISHMENT_LEAD_TIME: BigNumberField<ProductSupplyPlanning> = new BigNumberField('TotalReplenishmentLeadTime', ProductSupplyPlanning, 'Edm.Decimal')

Static representation of the totalReplenishmentLeadTime 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<ProductSupplyPlanning> | BigNumberField<ProductSupplyPlanning>> = [ProductSupplyPlanning.PRODUCT,ProductSupplyPlanning.PLANT,ProductSupplyPlanning.FIXED_LOT_SIZE_QUANTITY,ProductSupplyPlanning.MAXIMUM_LOT_SIZE_QUANTITY,ProductSupplyPlanning.MINIMUM_LOT_SIZE_QUANTITY,ProductSupplyPlanning.LOT_SIZE_ROUNDING_QUANTITY,ProductSupplyPlanning.LOT_SIZING_PROCEDURE,ProductSupplyPlanning.MRP_TYPE,ProductSupplyPlanning.MRP_RESPONSIBLE,ProductSupplyPlanning.SAFETY_STOCK_QUANTITY,ProductSupplyPlanning.MINIMUM_SAFETY_STOCK_QUANTITY,ProductSupplyPlanning.PLANNING_TIME_FENCE,ProductSupplyPlanning.ABC_INDICATOR,ProductSupplyPlanning.MAXIMUM_STOCK_QUANTITY,ProductSupplyPlanning.REORDER_THRESHOLD_QUANTITY,ProductSupplyPlanning.PLANNED_DELIVERY_DURATION_IN_DAYS,ProductSupplyPlanning.SAFETY_DURATION,ProductSupplyPlanning.PLANNING_STRATEGY_GROUP,ProductSupplyPlanning.TOTAL_REPLENISHMENT_LEAD_TIME,ProductSupplyPlanning.PROCUREMENT_TYPE,ProductSupplyPlanning.PROCUREMENT_SUB_TYPE,ProductSupplyPlanning.ASSEMBLY_SCRAP_PERCENT,ProductSupplyPlanning.AVAILABILITY_CHECK_TYPE,ProductSupplyPlanning.GOODS_RECEIPT_DURATION,ProductSupplyPlanning.MRP_GROUP]

All fields of the ProductSupplyPlanning entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_ProductSupplyPlanning"

Technical entity name for ProductSupplyPlanning.

Static _keyFields

_keyFields: Array<Selectable<ProductSupplyPlanning>> = [ProductSupplyPlanning.PRODUCT, ProductSupplyPlanning.PLANT]

All key fields of the ProductSupplyPlanning entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "API_PRODUCT_SRV"
deprecated

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

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

Static customField

  • Returns a selectable object that allows the selection of custom field in a get request for the entity ProductSupplyPlanning.

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<ProductSupplyPlanning>

    A builder that constructs instances of entity type ProductSupplyPlanning.

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

    • EntityT: Entity

    • JsonT

    Parameters

    • entityConstructor: Constructable<EntityT, JsonT>

    Returns EntityBuilderType<EntityT, JsonT>

Static requestBuilder

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

    Returns ProductSupplyPlanningRequestBuilder

    A ProductSupplyPlanning request builder.