Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "Batch" of service "cds_api_batch_srv". This service is part of the following communication scenarios: Batch Management OData Integration (SAP_COM_0337). See https://api.sap.com/api/API_BATCH_SRV for more information.

Hierarchy

  • Entity
    • Batch

Implements

Index

Constructors

constructor

  • Returns Batch

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 "*".

batch

batch: string

Batch Number. Assigns a material that is manufactured in batches or production lots to a specific batch. Maximum length: 10.

Optional batchBySupplier

batchBySupplier: undefined | string

Supplier Batch Number. Number under which the batch is managed at the supplier's. Maximum length: 15.

nullable

Optional batchExtWhseMgmtInternalId

batchExtWhseMgmtInternalId: undefined | string

Batch ID.

nullable

batchIdentifyingPlant

batchIdentifyingPlant: string

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

Optional batchIsMarkedForDeletion

batchIsMarkedForDeletion: undefined | false | true

Deletion Flag for All Data in a Batch. Indicator used to flag all data in a batch at client level for deletion. The reorganization program checks whether deletion is allowed. In this case, the batch data and all corresponding plants and storage locations are deleted.

nullable

Optional countryOfOrigin

countryOfOrigin: undefined | string

Country of Origin of Material (Non-Preferential Origin). Key of the country in which the material has been produced. You are legally required to specify the country of origin both for export and import.ExportYou prove the origin of a material by presenting the certificate of origin. This is issued and controlled by the relevant authority of the issuing country.This authority confirms the origin of a material and the required information with the certificate of origin.ImportThe relevant authority of the importing country - usually the Ministry of Economic Affairs - stipulates which regulations regarding customs and foreign trade law have to be observed for the certificates of origin accompanying goods.This information is used for foreign trade processing in different areas, such as:Foreign trade lawCustoms lawExample for Europe:Article 9 of the EU origin regulation is the legal regulation for the certificate of origin.The responsible authorities in Germany include:Chamber of Commerce (Industrie- und Handelskammer)Chamber of Handicrafts (Handwerkskammer)Customs office. Maximum length: 3.

nullable

Optional creationDateTime

creationDateTime: Moment

Created On Timestamp.

nullable

Optional freeDefinedDate1

freeDefinedDate1: Moment

Date for Free Use 1. The first batch date for individual use.

nullable

Optional freeDefinedDate2

freeDefinedDate2: Moment

Date for Free Use 2. The second batch date for individual use.

nullable

Optional freeDefinedDate3

freeDefinedDate3: Moment

Date for Free Use 3. The third batch date for individual use.

nullable

Optional freeDefinedDate4

freeDefinedDate4: Moment

Date for Free Use 4. The fourth batch date for individual use.

nullable

Optional freeDefinedDate5

freeDefinedDate5: Moment

Date for Free Use 5. The fifth batch date for individual use.

nullable

Optional freeDefinedDate6

freeDefinedDate6: Moment

Date for Free Use 6. The sixth batch date for individual use.

nullable

Optional lastChangeDateTime

lastChangeDateTime: Moment

Last Change Timestamp.

nullable

Optional manufactureDate

manufactureDate: Moment

Date of Manufacture.

nullable

material

material: string

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

Optional matlBatchAvailabilityDate

matlBatchAvailabilityDate: Moment

Availability date. Date as from which the batch is available.

nullable

Optional matlBatchIsInRstrcdUseStock

matlBatchIsInRstrcdUseStock: undefined | false | true

Batch in Restricted-Use Stock. Specifies that the batch is included in restricted-use stock. If, though a batch has the status "restricted", you want to use a goods movement to post a quantity to unrestricted-use stock, the quantity is posted to restricted-use stock and not to unrestricted-use stock.If the status of a batch is set to restricted, the total unrestricted-use stock is transferred to restricted-use stock by means of a transfer posting. A material document is created.You cannot change the status of a batch (unrestricted/restricted) in a goods movement, only with the following functions:by maintaining the batch master record manuallyusing the control function provided in the QM systemConfigurations for Restricted-Use StockFor planning purposes, restricted-use stock is treated like blocked stock, that is, it is either available or not available, depending on your system configuration.Withdrawals from restricted-use stock are either possible or not possible, depending on your system configuration.The status of a batch can be considered in batch determination, that is, you can search for unrestricted or for restricted batches.

nullable

Optional regionOfOrigin

regionOfOrigin: undefined | string

Region of Origin of Material (Non-Preferential Origin). Describes more precisely the origin of goods. You can enter a region of the country from which the goods originate.This information is required for the declarations regarding goods dispatches/imports and goods receipts/exports which are made to the authorities. Declarations to the authorities for foreign trade are a legal requirement in many countries.INTRASTAT - Declaration in the European UnionEXTRASTAT - Declaration in the European UnionIn the materials management document, the 'region of destination' field indicates the region of the receiving plant. Maximum length: 3.

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 shelfLifeExpirationDate

shelfLifeExpirationDate: Moment

Shelf Life Expiration or Best-Before Date. The date is set upon goods receipt in one of the following ways: You enter it yourself.You enter a date of production, and the system calculates the shelf life expiration date from the date of production plus the shelf life in days (from the material master record).NoteThis date can still be changed upon receipt of the usage decision for an inspection lot.

nullable

Optional supplier

supplier: undefined | string

Supplier's Account Number. Alphanumeric key uniquely identifying the document. With the supplier number, information from the supplier master record (such as the supplier's address and bank details) is copied into a purchasing document (such as a request for quotation or a purchase order).You can use the supplier number to keep track of requests for quotation, purchase orders and outline agreements. Maximum length: 10.

nullable

toBatchCharc

toBatchCharc: BatchCharc[]

One-to-many navigation property to the BatchCharc entity.

toBatchClass

toBatchClass: BatchClass

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

toBatchPlant

toBatchPlant: BatchPlant[]

One-to-many navigation property to the BatchPlant 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<Batch> = new AllFields('*', Batch)

All fields selector.

Static BATCH

BATCH: StringField<Batch> = new StringField('Batch', Batch, 'Edm.String')

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

Static BATCH_BY_SUPPLIER

BATCH_BY_SUPPLIER: StringField<Batch> = new StringField('BatchBySupplier', Batch, 'Edm.String')

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

Static BATCH_EXT_WHSE_MGMT_INTERNAL_ID

BATCH_EXT_WHSE_MGMT_INTERNAL_ID: StringField<Batch> = new StringField('BatchExtWhseMgmtInternalId', Batch, 'Edm.Guid')

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

Static BATCH_IDENTIFYING_PLANT

BATCH_IDENTIFYING_PLANT: StringField<Batch> = new StringField('BatchIdentifyingPlant', Batch, 'Edm.String')

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

Static BATCH_IS_MARKED_FOR_DELETION

BATCH_IS_MARKED_FOR_DELETION: BooleanField<Batch> = new BooleanField('BatchIsMarkedForDeletion', Batch, 'Edm.Boolean')

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

Static COUNTRY_OF_ORIGIN

COUNTRY_OF_ORIGIN: StringField<Batch> = new StringField('CountryOfOrigin', Batch, 'Edm.String')

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

Static CREATION_DATE_TIME

CREATION_DATE_TIME: DateField<Batch> = new DateField('CreationDateTime', Batch, 'Edm.DateTimeOffset')

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

Static FREE_DEFINED_DATE_1

FREE_DEFINED_DATE_1: DateField<Batch> = new DateField('FreeDefinedDate1', Batch, 'Edm.DateTime')

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

Static FREE_DEFINED_DATE_2

FREE_DEFINED_DATE_2: DateField<Batch> = new DateField('FreeDefinedDate2', Batch, 'Edm.DateTime')

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

Static FREE_DEFINED_DATE_3

FREE_DEFINED_DATE_3: DateField<Batch> = new DateField('FreeDefinedDate3', Batch, 'Edm.DateTime')

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

Static FREE_DEFINED_DATE_4

FREE_DEFINED_DATE_4: DateField<Batch> = new DateField('FreeDefinedDate4', Batch, 'Edm.DateTime')

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

Static FREE_DEFINED_DATE_5

FREE_DEFINED_DATE_5: DateField<Batch> = new DateField('FreeDefinedDate5', Batch, 'Edm.DateTime')

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

Static FREE_DEFINED_DATE_6

FREE_DEFINED_DATE_6: DateField<Batch> = new DateField('FreeDefinedDate6', Batch, 'Edm.DateTime')

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

Static LAST_CHANGE_DATE_TIME

LAST_CHANGE_DATE_TIME: DateField<Batch> = new DateField('LastChangeDateTime', Batch, 'Edm.DateTimeOffset')

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

Static MANUFACTURE_DATE

MANUFACTURE_DATE: DateField<Batch> = new DateField('ManufactureDate', Batch, 'Edm.DateTime')

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

Static MATERIAL

MATERIAL: StringField<Batch> = new StringField('Material', Batch, '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 MATL_BATCH_AVAILABILITY_DATE

MATL_BATCH_AVAILABILITY_DATE: DateField<Batch> = new DateField('MatlBatchAvailabilityDate', Batch, 'Edm.DateTime')

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

Static MATL_BATCH_IS_IN_RSTRCD_USE_STOCK

MATL_BATCH_IS_IN_RSTRCD_USE_STOCK: BooleanField<Batch> = new BooleanField('MatlBatchIsInRstrcdUseStock', Batch, 'Edm.Boolean')

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

Static REGION_OF_ORIGIN

REGION_OF_ORIGIN: StringField<Batch> = new StringField('RegionOfOrigin', Batch, 'Edm.String')

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

Static SHELF_LIFE_EXPIRATION_DATE

SHELF_LIFE_EXPIRATION_DATE: DateField<Batch> = new DateField('ShelfLifeExpirationDate', Batch, 'Edm.DateTime')

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

Static SUPPLIER

SUPPLIER: StringField<Batch> = new StringField('Supplier', Batch, 'Edm.String')

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

Static TO_BATCH_CHARC

TO_BATCH_CHARC: Link<Batch, BatchCharc> = new Link('to_BatchCharc', Batch, BatchCharc)

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

Static TO_BATCH_CLASS

TO_BATCH_CLASS: OneToOneLink<Batch, BatchClass> = new OneToOneLink('to_BatchClass', Batch, BatchClass)

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

Static TO_BATCH_PLANT

TO_BATCH_PLANT: Link<Batch, BatchPlant> = new Link('to_BatchPlant', Batch, BatchPlant)

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

Static _allFields

_allFields: Array<StringField<Batch> | BooleanField<Batch> | DateField<Batch> | Link<Batch, BatchCharc> | OneToOneLink<Batch, BatchClass> | Link<Batch, BatchPlant>> = [Batch.MATERIAL,Batch.BATCH_IDENTIFYING_PLANT,Batch.BATCH,Batch.BATCH_IS_MARKED_FOR_DELETION,Batch.MATL_BATCH_IS_IN_RSTRCD_USE_STOCK,Batch.SUPPLIER,Batch.BATCH_BY_SUPPLIER,Batch.COUNTRY_OF_ORIGIN,Batch.REGION_OF_ORIGIN,Batch.MATL_BATCH_AVAILABILITY_DATE,Batch.SHELF_LIFE_EXPIRATION_DATE,Batch.MANUFACTURE_DATE,Batch.FREE_DEFINED_DATE_1,Batch.FREE_DEFINED_DATE_2,Batch.FREE_DEFINED_DATE_3,Batch.FREE_DEFINED_DATE_4,Batch.FREE_DEFINED_DATE_5,Batch.FREE_DEFINED_DATE_6,Batch.CREATION_DATE_TIME,Batch.LAST_CHANGE_DATE_TIME,Batch.BATCH_EXT_WHSE_MGMT_INTERNAL_ID,Batch.TO_BATCH_CHARC,Batch.TO_BATCH_CLASS,Batch.TO_BATCH_PLANT]

All fields of the Batch entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "Batch"

Technical entity name for Batch.

Static _keyFields

_keyFields: Array<Selectable<Batch>> = [Batch.MATERIAL, Batch.BATCH_IDENTIFYING_PLANT, Batch.BATCH]

All key fields of the Batch entity.

Static _keys

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

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

Type declaration

Static _serviceName

_serviceName: string = "cds_api_batch_srv"
deprecated

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

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<Batch>
  • Returns a selectable object that allows the selection of custom field in a get request for the entity Batch.

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<Batch>

    A builder that constructs instances of entity type Batch.

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

    Returns BatchRequestBuilder

    A Batch request builder.