Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_ProductPlantForecasting" 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
    • ProductPlantForecasting

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 consumptionQtyMultiplier

consumptionQtyMultiplier: BigNumber

Multiplier for reference material for consumption. Determines how much of the consumption quantity of the reference material should be used for the material forecast. If you want exactly 100 % of the consumption quantity of the reference material to be used for the forecast of this material, enter 1.If you want only 70 % of the consumption quantity of the reference material to be used for the forecast of this material, enter 0,7.

nullable

Optional consumptionRefUsageEndDate

consumptionRefUsageEndDate: Moment

To date of the material to be copied for consumption. Date until which the consumption data of the reference material is used for the material forecast. If you have defined a reference material, you must enter a validity date. Up to the specified validity date, the system accesses the consumption data of the reference material, from this date, it accesses the material's own consumption data.

nullable

Optional consumptionReferencePlant

consumptionReferencePlant: string

Reference plant for consumption. Plant of the reference material on whose consumption data the material forecast is based. This field is intended for new materials without any consumption statistics for the system to access in the forecast. If you have defined a reference material, the system accesses the consumption data that exists for it in this plant and continues to do so up to the validity date specified by you.If no plant has been specified for the reference material, the system takes the plant for the material itself as the reference work automatically. Maximum length: 4.

nullable

Optional consumptionReferenceProduct

consumptionReferenceProduct: string

Reference material for consumption. The system uses the consumption data of this material for the forecast. This field exists for new materials which do not yet have their own consumption statistics that the system can use in the forecast. If you have defined a reference material, the system accesses the consumption data of this material up to the validity date that you specified for it. Maximum length: 40.

nullable

plant

plant: string

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

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

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<ProductPlantForecasting> = new AllFields('*', ProductPlantForecasting)

All fields selector.

Static CONSUMPTION_QTY_MULTIPLIER

CONSUMPTION_QTY_MULTIPLIER: BigNumberField<ProductPlantForecasting> = new BigNumberField('ConsumptionQtyMultiplier', ProductPlantForecasting, 'Edm.Decimal')

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

Static CONSUMPTION_REFERENCE_PLANT

CONSUMPTION_REFERENCE_PLANT: StringField<ProductPlantForecasting> = new StringField('ConsumptionReferencePlant', ProductPlantForecasting, 'Edm.String')

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

Static CONSUMPTION_REFERENCE_PRODUCT

CONSUMPTION_REFERENCE_PRODUCT: StringField<ProductPlantForecasting> = new StringField('ConsumptionReferenceProduct', ProductPlantForecasting, 'Edm.String')

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

Static CONSUMPTION_REF_USAGE_END_DATE

CONSUMPTION_REF_USAGE_END_DATE: DateField<ProductPlantForecasting> = new DateField('ConsumptionRefUsageEndDate', ProductPlantForecasting, 'Edm.DateTime')

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

Static PLANT

PLANT: StringField<ProductPlantForecasting> = new StringField('Plant', ProductPlantForecasting, '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 PRODUCT

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

_allFields: Array<StringField<ProductPlantForecasting> | DateField<ProductPlantForecasting> | BigNumberField<ProductPlantForecasting>> = [ProductPlantForecasting.PRODUCT,ProductPlantForecasting.PLANT,ProductPlantForecasting.CONSUMPTION_REF_USAGE_END_DATE,ProductPlantForecasting.CONSUMPTION_QTY_MULTIPLIER,ProductPlantForecasting.CONSUMPTION_REFERENCE_PRODUCT,ProductPlantForecasting.CONSUMPTION_REFERENCE_PLANT]

All fields of the ProductPlantForecasting entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_ProductPlantForecasting"

Technical entity name for ProductPlantForecasting.

Static _keyFields

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

All key fields of the ProductPlantForecasting entity.

Static _keys

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

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

Static _serviceName

_serviceName: string = "API_PRODUCT_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<ProductPlantForecasting>

    A builder that constructs instances of entity type ProductPlantForecasting.

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

    Returns ProductPlantForecastingRequestBuilder

    A ProductPlantForecasting request builder.