Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_ActualStock" of service "cds_api_buffersizing_srv". This service is part of the following communication scenarios: Buffer Sizing Integration (SAP_COM_0359). See https://api.sap.com/api/API_BUFFERSIZING_SRV for more information.

Hierarchy

  • Entity
    • ActualStock

Implements

Index

Constructors

constructor

  • Returns ActualStock

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 baseUnit

baseUnit: undefined | string

Base Unit of Measure. Unit of measure in which stocks of the material are managed. The system converts all the quantities you enter in other units of measure (alternative units of measure) to the base unit of measure. You define the base unit of measure and also alternative units of measure and their conversion factors in the material master record.Since all data is updated in the base unit of measure, your entry is particularly important for the conversion of alternative units of measure. A quantity in the alternative unit of measure can only be shown precisely if its value can be shown with the decimal places available. To ensure this, please note the following:The base unit of measure is the unit satisfying the highest necessary requirement for precision.The conversion of alternative units of measure to the base unit should result in simple decimal fractions (not, for example, 1/3 = 0.333...).Inventory ManagementIn Inventory Management, the base unit of measure is the same as the stockkeeping unit.ServicesServices have units of measure of their own, including the following:Service unitUnit of measure at the higher item level. The precise quantities of the individual services are each at the detailed service line level.BlanketUnit of measure at service line level for services to be provided once only, and for which no precise quantities can or are to be specified. Maximum length: 3.

nullable

Optional bufferLevelEndDate

bufferLevelEndDate: Moment

Valid-To Date.

nullable

bufferLevelStartDate

bufferLevelStartDate: Moment

Valid-From Date.

Optional changeMode

changeMode: undefined | string

Mode of change. Maximum length: 1.

nullable

material

material: string

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

Optional materialMaxStockLevelQuantity

materialMaxStockLevelQuantity: 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 materialSafetyStockQty

materialSafetyStockQty: 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

mrpArea

mrpArea: string

MRP Area. Number of the MRP area for which material requirements planning should be carried out separately. Maximum length: 10.

plant

plant: string

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

Optional proposalStartDate

proposalStartDate: Moment

Proposal Validity From Date.

nullable

Optional proposalVersion

proposalVersion: undefined | string

Proposal Version. Maximum length: 8.

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 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 stockLevelProposalId

stockLevelProposalId: undefined | string

Proposal Id. Maximum length: 75.

nullable

toProposalHdr

toProposalHdr: ProposalHeader

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

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

All fields selector.

Static BASE_UNIT

BASE_UNIT: StringField<ActualStock> = new StringField('BaseUnit', ActualStock, '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 BUFFER_LEVEL_END_DATE

BUFFER_LEVEL_END_DATE: DateField<ActualStock> = new DateField('BufferLevelEndDate', ActualStock, 'Edm.DateTime')

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

Static BUFFER_LEVEL_START_DATE

BUFFER_LEVEL_START_DATE: DateField<ActualStock> = new DateField('BufferLevelStartDate', ActualStock, 'Edm.DateTime')

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

Static CHANGE_MODE

CHANGE_MODE: StringField<ActualStock> = new StringField('ChangeMode', ActualStock, 'Edm.String')

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

Static MATERIAL

MATERIAL: StringField<ActualStock> = new StringField('Material', ActualStock, 'Edm.String')

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

Static MATERIAL_MAX_STOCK_LEVEL_QUANTITY

MATERIAL_MAX_STOCK_LEVEL_QUANTITY: BigNumberField<ActualStock> = new BigNumberField('MaterialMaxStockLevelQuantity', ActualStock, 'Edm.Decimal')

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

Static MATERIAL_SAFETY_STOCK_QTY

MATERIAL_SAFETY_STOCK_QTY: BigNumberField<ActualStock> = new BigNumberField('MaterialSafetyStockQty', ActualStock, 'Edm.Decimal')

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

Static MRP_AREA

MRP_AREA: StringField<ActualStock> = new StringField('MRPArea', ActualStock, 'Edm.String')

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

Static PLANT

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

PROPOSAL_START_DATE: DateField<ActualStock> = new DateField('ProposalStartDate', ActualStock, 'Edm.DateTime')

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

Static PROPOSAL_VERSION

PROPOSAL_VERSION: StringField<ActualStock> = new StringField('ProposalVersion', ActualStock, 'Edm.String')

Static representation of the proposalVersion 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<ActualStock> = new BigNumberField('ReorderThresholdQuantity', ActualStock, '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 STOCK_LEVEL_PROPOSAL_ID

STOCK_LEVEL_PROPOSAL_ID: StringField<ActualStock> = new StringField('StockLevelProposalID', ActualStock, 'Edm.String')

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

Static TO_PROPOSAL_HDR

TO_PROPOSAL_HDR: OneToOneLink<ActualStock, ProposalHeader> = new OneToOneLink('to_ProposalHdr', ActualStock, ProposalHeader)

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

Static _allFields

_allFields: Array<StringField<ActualStock> | DateField<ActualStock> | BigNumberField<ActualStock> | OneToOneLink<ActualStock, ProposalHeader>> = [ActualStock.MATERIAL,ActualStock.PLANT,ActualStock.MRP_AREA,ActualStock.BUFFER_LEVEL_START_DATE,ActualStock.BUFFER_LEVEL_END_DATE,ActualStock.MATERIAL_SAFETY_STOCK_QTY,ActualStock.REORDER_THRESHOLD_QUANTITY,ActualStock.MATERIAL_MAX_STOCK_LEVEL_QUANTITY,ActualStock.BASE_UNIT,ActualStock.CHANGE_MODE,ActualStock.STOCK_LEVEL_PROPOSAL_ID,ActualStock.PROPOSAL_VERSION,ActualStock.PROPOSAL_START_DATE,ActualStock.TO_PROPOSAL_HDR]

All fields of the ActualStock entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_ActualStock"

Technical entity name for ActualStock.

Static _keyFields

_keyFields: Array<Selectable<ActualStock>> = [ActualStock.MATERIAL, ActualStock.PLANT, ActualStock.MRP_AREA, ActualStock.BUFFER_LEVEL_START_DATE]

All key fields of the ActualStock entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "cds_api_buffersizing_srv"
deprecated

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

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<ActualStock>

    A builder that constructs instances of entity type ActualStock.

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

    Returns ActualStockRequestBuilder

    A ActualStock request builder.