Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_ProductStorage" of service "API_PRODUCT_SRV". This service is part of the following communication scenarios: Distributed Manufacturing Integration (SAP_COM_0077), SAP Analytics Cloud for Planning Integration (SAP_COM_0087), Product Integration (SAP_COM_0009). See https://api.sap.com/api/API_PRODUCT_SRV for more information.

Hierarchy

  • Entity
    • ProductStorage

Implements

Index

Constructors

constructor

  • Returns ProductStorage

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 expirationDate

expirationDate: string

Expiration Date. Indicator for the shelf life expiration date or expiration date. In batch management, the shelf life expiration date or expiration date can be specified. You select the date type you want by using this indicator. Maximum length: 1.

nullable

Optional hazardousMaterialNumber

hazardousMaterialNumber: string

Hazardous material number. Number that identifies the material as a hazardous material or as dangerous goods and assigns hazardous material data or dangerous goods data to it. The hazardous material number indicates that the material is dangerous, making special precautions necessary for its storage and shipment.You can enter region-specific hazardous material data or dangerous goods data separately under one hazardous material number. Maximum length: 40.

nullable

Optional labelForm

labelForm: string

Label form. Determines the size and layout of the label. The label form specifies, for example, whether the label is an adhesive or a pin-on label. Maximum length: 2.

nullable

Optional labelType

labelType: string

Label type. Determines the way labels are created. The label type specifies, for example, whether labels are preprinted by the supplier or created on a central printer. Maximum length: 2.

nullable

Optional minRemainingShelfLife

minRemainingShelfLife: BigNumber

Minimum Remaining Shelf Life. Minimum amount of time for which the material must keep upon goods receipt for the goods receipt to be accepted by the system. The period (day, week, month, year) depends on the entry in the Period indicator field.

nullable

Optional nmbrOfGrOrGiSlipsToPrintQty

nmbrOfGrOrGiSlipsToPrintQty: BigNumber

Quantity: Number of GR/GI slips to be printed. Specifies which quantity of the material, in the unit of entry, usually constitutes a pallet load. In the case of a goods receipt with reference to a purchase order or production order, the system automatically calculates the number of GR/GI slips to be printed for the material document item as a quotient from the goods receipt quantity and the quantity defined here.The value determined is always rounded up to the next higher whole number.If you enter nothing in this field, the material document item is only printed on one goods receipt/issue slip.

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 storageConditions

storageConditions: string

Storage conditions. Indicates what storage conditions are required for the material. Maximum length: 2.

nullable

Optional temperatureConditionInd

temperatureConditionInd: string

Temperature conditions indicator. Indicates the temperature conditions in which the material should be stored. Maximum length: 2.

nullable

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

All fields selector.

Static EXPIRATION_DATE

EXPIRATION_DATE: StringField<ProductStorage> = new StringField('ExpirationDate', ProductStorage, 'Edm.String')

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

Static HAZARDOUS_MATERIAL_NUMBER

HAZARDOUS_MATERIAL_NUMBER: StringField<ProductStorage> = new StringField('HazardousMaterialNumber', ProductStorage, 'Edm.String')

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

Static LABEL_FORM

LABEL_FORM: StringField<ProductStorage> = new StringField('LabelForm', ProductStorage, 'Edm.String')

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

Static LABEL_TYPE

LABEL_TYPE: StringField<ProductStorage> = new StringField('LabelType', ProductStorage, 'Edm.String')

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

Static MIN_REMAINING_SHELF_LIFE

MIN_REMAINING_SHELF_LIFE: BigNumberField<ProductStorage> = new BigNumberField('MinRemainingShelfLife', ProductStorage, 'Edm.Decimal')

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

Static NMBR_OF_GR_OR_GI_SLIPS_TO_PRINT_QTY

NMBR_OF_GR_OR_GI_SLIPS_TO_PRINT_QTY: BigNumberField<ProductStorage> = new BigNumberField('NmbrOfGROrGISlipsToPrintQty', ProductStorage, 'Edm.Decimal')

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

Static PRODUCT

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

STORAGE_CONDITIONS: StringField<ProductStorage> = new StringField('StorageConditions', ProductStorage, 'Edm.String')

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

Static TEMPERATURE_CONDITION_IND

TEMPERATURE_CONDITION_IND: StringField<ProductStorage> = new StringField('TemperatureConditionInd', ProductStorage, 'Edm.String')

Static representation of the temperatureConditionInd 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<ProductStorage> | BigNumberField<ProductStorage>> = [ProductStorage.PRODUCT,ProductStorage.STORAGE_CONDITIONS,ProductStorage.TEMPERATURE_CONDITION_IND,ProductStorage.HAZARDOUS_MATERIAL_NUMBER,ProductStorage.NMBR_OF_GR_OR_GI_SLIPS_TO_PRINT_QTY,ProductStorage.LABEL_TYPE,ProductStorage.LABEL_FORM,ProductStorage.MIN_REMAINING_SHELF_LIFE,ProductStorage.EXPIRATION_DATE]

All fields of the ProductStorage entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_ProductStorage"

Technical entity name for ProductStorage.

Static _keyFields

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

All key fields of the ProductStorage entity.

Static _keys

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

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

Static _serviceName

_serviceName: string = "API_PRODUCT_SRV"
deprecated

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

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

    Returns EntityBuilderType<ProductStorage, ProductStorageType>

    A builder that constructs instances of entity type ProductStorage.

Static customField

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<ProductStorage>

    A builder that constructs instances of entity type ProductStorage.

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

    Returns ProductStorageRequestBuilder

    A ProductStorage request builder.