Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_ProductStorageLocation" 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
    • ProductStorageLocation

Implements

Index

Constructors

Properties

Methods

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 creationDate

creationDate: Moment

Created On. Date on which the record was created.

nullable

Optional dateOfLastPostedCntUnRstrcdStk

dateOfLastPostedCntUnRstrcdStk: Moment

Date of Last Posted Count. Indicates the date on which the material was last counted. The date of the last count is only used for cycle counting. It is used as the basis for determining the next count date."Date of last posted count date" means the following:This indicates the date when the latest physical inventory count was posted for the specified material. The physical inventory count with the most recent date is always indicated.Examples:You executed and posted the last physical inventory count on 13th May. If you post a new physical inventory count on 2nd June, the 2nd June is then displayed as the date of the last count.You executed and posted the last physical inventory count on 2nd June. If you now post another physical inventory count for the one executed and posted on 13th May, the 2nd June is still displayed as the date of the last physical inventory count.Posting an inventory difference does not affect the specified date of the last physical inventory count. The date of the last physical inventory count is only valuated during the cycle counting, in order to determine the next count date.

nullable

Optional fiscalMonthCurrentPeriod

fiscalMonthCurrentPeriod: string

Fiscal Month Current Period. Maximum length: 2.

nullable

Optional fiscalYearCurrentInvtryPeriod

fiscalYearCurrentInvtryPeriod: string

Fiscal year of current physical inventory indicator. Maximum length: 4.

nullable

Optional fiscalYearCurrentPeriod

fiscalYearCurrentPeriod: string

Fiscal Year Current Period. Maximum length: 4.

nullable

Optional hasInvtryBlockStockPrevPeriod

hasInvtryBlockStockPrevPeriod: string

Phys. inventory indicator for blocked stock in prev. period. Maximum length: 3.

nullable

Optional inventoryBlockStockInd

inventoryBlockStockInd: string

Physical inventory indicator for blocked stock. Records the physical inventory status of the respective stock. The following statuses are possible: If the physical inventory still has to be taken in the current year:Physical inventory still has to be taken: _ _ _Physical inventory still has to be completed: _ X _Posting block is set in active document: X X _If the physical inventory has already been taken in the current year:Physical inventory has been taken: _ _ XPhysical inventory is active again: _ X XPosting block is set in active document: X X X. Maximum length: 3.

nullable

Optional inventoryCorrectionFactor

inventoryCorrectionFactor: number

Inventory Correction Factor. When carrying out requirements planning or ATP check, you can use the inventory correction factor to take into account stocks that are actually available in proportion units at plant and storage location level.

nullable

Optional inventoryStockPrevPeriod

inventoryStockPrevPeriod: string

Physical inventory indicator for stock in previous year. Maximum length: 3.

nullable

Optional invtryCurrentYearStockInd

invtryCurrentYearStockInd: string

Physical inventory indicator for whse stock in current year. Records the physical inventory status of the respective stock. The following statuses are possible: If the physical inventory still has to be taken in the current year:Physical inventory still has to be taken: _ _ _Physical inventory still has to be completed: _ X _Posting block is set in active document: X X _If the physical inventory has already been taken in the current year:Physical inventory has been taken: _ _ XPhysical inventory is active again: _ X XPosting block is set in active document: X X X. Maximum length: 3.

nullable

Optional invtryQualInspCurrentYrStkInd

invtryQualInspCurrentYrStkInd: string

Phys. inventory ind. f. stock in qual. insp. in current year. Records the physical inventory status of the respective stock. The following statuses are possible: If the physical inventory still has to be taken in the current year:Physical inventory still has to be taken: _ _ _Physical inventory still has to be completed: _ X _Posting block is set in active document: X X _If the physical inventory has already been taken in the current year:Physical inventory has been taken: _ _ XPhysical inventory is active again: _ X XPosting block is set in active document: X X X. Maximum length: 3.

nullable

Optional invtryRestStockPrevPeriodInd

invtryRestStockPrevPeriodInd: string

Physical inventory ind. for restricted-use stock, prev.pd. Maximum length: 3.

nullable

Optional invtryRestrictedUseStockInd

invtryRestrictedUseStockInd: string

Physical inventory indicator for restricted-use stock. Records the physical inventory status of the respective stock. The following statuses are possible: If the physical inventory still has to be taken in the current year:Physical inventory still has to be taken: _ _ _Physical inventory still has to be completed: _ X _Posting block is set in active document: X X _If the physical inventory has already been taken in the current year:Physical inventory has been taken: _ _ XPhysical inventory is active again: _ X XPosting block is set in active document: X X X. Maximum length: 3.

nullable

Optional invtryStockQltyInspPrevPeriod

invtryStockQltyInspPrevPeriod: string

Phys. inventory ind. f. stock in qual. insp. in prev. period. Maximum length: 3.

nullable

Optional isMarkedForDeletion

isMarkedForDeletion: boolean

Flag Material for Deletion at Storage Location Level. Indicates that the flag for deletion has been set in the material master record. If this indicator is set, the archive and delete program checks whether the material may be deleted at storage location level, and deletes the data at this level.

nullable

Optional maintenanceStatus

maintenanceStatus: string

Maintenance status. The maintenance status records: Which user departments may maintain a material master record of a particular material typeWhich user departments have already maintained the material master record at a particular hierarchy levelThe overall maintenance status is made up of the individual maintenance statuses. The individual maintenance statuses have the following meaning:User department Maintenance statusWork scheduling AAccounting BClassification CMRP DPurchasing EProduction resources/tools FCosting GBasic data KStorage LForecasting PQuality management QWarehouse management SSales VPlant stocks XStorage location stocks Z. Maximum length: 15.

nullable

Optional physicalInventoryBlockInd

physicalInventoryBlockInd: string

Physical Inventory Blocking Indicator. Indicator that specifies that the stock is blocked for a physical inventory. Maximum length: 1.

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

storageLocation

storageLocation: string

Storage Location. Number of the storage location in which the material is stored. A plant may contain one or more storage locations. Maximum length: 4.

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

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

Optional warehouseStorageBin

warehouseStorageBin: string

Storage Bin. Identifies the storage bin within a storage location where the material is stored. This storage bin is only significant if you do not use SAP warehouse management. It appears on goods receipt/issue slips.However, if the warehouse management system is active, this value is merely for information. Maximum length: 10.

nullable

Static ALL_FIELDS

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

All fields selector.

Static CREATION_DATE

CREATION_DATE: DateField<ProductStorageLocation> = new DateField('CreationDate', ProductStorageLocation, '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 DATE_OF_LAST_POSTED_CNT_UN_RSTRCD_STK

DATE_OF_LAST_POSTED_CNT_UN_RSTRCD_STK: DateField<ProductStorageLocation> = new DateField('DateOfLastPostedCntUnRstrcdStk', ProductStorageLocation, 'Edm.DateTime')

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

Static FISCAL_MONTH_CURRENT_PERIOD

FISCAL_MONTH_CURRENT_PERIOD: StringField<ProductStorageLocation> = new StringField('FiscalMonthCurrentPeriod', ProductStorageLocation, 'Edm.String')

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

Static FISCAL_YEAR_CURRENT_INVTRY_PERIOD

FISCAL_YEAR_CURRENT_INVTRY_PERIOD: StringField<ProductStorageLocation> = new StringField('FiscalYearCurrentInvtryPeriod', ProductStorageLocation, 'Edm.String')

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

Static FISCAL_YEAR_CURRENT_PERIOD

FISCAL_YEAR_CURRENT_PERIOD: StringField<ProductStorageLocation> = new StringField('FiscalYearCurrentPeriod', ProductStorageLocation, 'Edm.String')

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

Static HAS_INVTRY_BLOCK_STOCK_PREV_PERIOD

HAS_INVTRY_BLOCK_STOCK_PREV_PERIOD: StringField<ProductStorageLocation> = new StringField('HasInvtryBlockStockPrevPeriod', ProductStorageLocation, 'Edm.String')

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

Static INVENTORY_BLOCK_STOCK_IND

INVENTORY_BLOCK_STOCK_IND: StringField<ProductStorageLocation> = new StringField('InventoryBlockStockInd', ProductStorageLocation, 'Edm.String')

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

Static INVENTORY_CORRECTION_FACTOR

INVENTORY_CORRECTION_FACTOR: NumberField<ProductStorageLocation> = new NumberField('InventoryCorrectionFactor', ProductStorageLocation, 'Edm.Double')

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

Static INVENTORY_STOCK_PREV_PERIOD

INVENTORY_STOCK_PREV_PERIOD: StringField<ProductStorageLocation> = new StringField('InventoryStockPrevPeriod', ProductStorageLocation, 'Edm.String')

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

Static INVTRY_CURRENT_YEAR_STOCK_IND

INVTRY_CURRENT_YEAR_STOCK_IND: StringField<ProductStorageLocation> = new StringField('InvtryCurrentYearStockInd', ProductStorageLocation, 'Edm.String')

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

Static INVTRY_QUAL_INSP_CURRENT_YR_STK_IND

INVTRY_QUAL_INSP_CURRENT_YR_STK_IND: StringField<ProductStorageLocation> = new StringField('InvtryQualInspCurrentYrStkInd', ProductStorageLocation, 'Edm.String')

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

Static INVTRY_RESTRICTED_USE_STOCK_IND

INVTRY_RESTRICTED_USE_STOCK_IND: StringField<ProductStorageLocation> = new StringField('InvtryRestrictedUseStockInd', ProductStorageLocation, 'Edm.String')

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

Static INVTRY_REST_STOCK_PREV_PERIOD_IND

INVTRY_REST_STOCK_PREV_PERIOD_IND: StringField<ProductStorageLocation> = new StringField('InvtryRestStockPrevPeriodInd', ProductStorageLocation, 'Edm.String')

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

Static INVTRY_STOCK_QLTY_INSP_PREV_PERIOD

INVTRY_STOCK_QLTY_INSP_PREV_PERIOD: StringField<ProductStorageLocation> = new StringField('InvtryStockQltyInspPrevPeriod', ProductStorageLocation, 'Edm.String')

Static representation of the invtryStockQltyInspPrevPeriod 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<ProductStorageLocation> = new BooleanField('IsMarkedForDeletion', ProductStorageLocation, '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 MAINTENANCE_STATUS

MAINTENANCE_STATUS: StringField<ProductStorageLocation> = new StringField('MaintenanceStatus', ProductStorageLocation, 'Edm.String')

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

Static PHYSICAL_INVENTORY_BLOCK_IND

PHYSICAL_INVENTORY_BLOCK_IND: StringField<ProductStorageLocation> = new StringField('PhysicalInventoryBlockInd', ProductStorageLocation, 'Edm.String')

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

Static PLANT

PLANT: StringField<ProductStorageLocation> = new StringField('Plant', ProductStorageLocation, '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<ProductStorageLocation> = new StringField('Product', ProductStorageLocation, '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 STORAGE_LOCATION

STORAGE_LOCATION: StringField<ProductStorageLocation> = new StringField('StorageLocation', ProductStorageLocation, 'Edm.String')

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

Static WAREHOUSE_STORAGE_BIN

WAREHOUSE_STORAGE_BIN: StringField<ProductStorageLocation> = new StringField('WarehouseStorageBin', ProductStorageLocation, 'Edm.String')

Static representation of the warehouseStorageBin 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<ProductStorageLocation> | DateField<ProductStorageLocation> | BooleanField<ProductStorageLocation> | NumberField<ProductStorageLocation>> = [ProductStorageLocation.PRODUCT,ProductStorageLocation.PLANT,ProductStorageLocation.STORAGE_LOCATION,ProductStorageLocation.WAREHOUSE_STORAGE_BIN,ProductStorageLocation.MAINTENANCE_STATUS,ProductStorageLocation.PHYSICAL_INVENTORY_BLOCK_IND,ProductStorageLocation.CREATION_DATE,ProductStorageLocation.IS_MARKED_FOR_DELETION,ProductStorageLocation.DATE_OF_LAST_POSTED_CNT_UN_RSTRCD_STK,ProductStorageLocation.INVENTORY_CORRECTION_FACTOR,ProductStorageLocation.INVTRY_RESTRICTED_USE_STOCK_IND,ProductStorageLocation.INVTRY_CURRENT_YEAR_STOCK_IND,ProductStorageLocation.INVTRY_QUAL_INSP_CURRENT_YR_STK_IND,ProductStorageLocation.INVENTORY_BLOCK_STOCK_IND,ProductStorageLocation.INVTRY_REST_STOCK_PREV_PERIOD_IND,ProductStorageLocation.INVENTORY_STOCK_PREV_PERIOD,ProductStorageLocation.INVTRY_STOCK_QLTY_INSP_PREV_PERIOD,ProductStorageLocation.HAS_INVTRY_BLOCK_STOCK_PREV_PERIOD,ProductStorageLocation.FISCAL_YEAR_CURRENT_PERIOD,ProductStorageLocation.FISCAL_MONTH_CURRENT_PERIOD,ProductStorageLocation.FISCAL_YEAR_CURRENT_INVTRY_PERIOD]

All fields of the ProductStorageLocation entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_ProductStorageLocation"

Technical entity name for ProductStorageLocation.

Static _keyFields

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

All key fields of the ProductStorageLocation entity.

Static _keys

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

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

Static _serviceName

_serviceName: string = "API_PRODUCT_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<ProductStorageLocation>

    A builder that constructs instances of entity type ProductStorageLocation.

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

    Returns ProductStorageLocationRequestBuilder

    A ProductStorageLocation request builder.