Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "ProcOrdConfMatlDocItm" of service "API_PROC_ORDER_CONFIRMATION_2_SRV". This service is part of the following communication scenarios: Production Planning Integration (SAP_COM_0104). See https://api.sap.com/api/API_PROC_ORDER_CONFIRMATION_2_SRV for more information.

Hierarchy

  • Entity
    • ProcOrdConfMatlDocItm

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns ProcOrdConfMatlDocItm

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 batch

batch: string

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

nullable

confirmationCount

confirmationCount: string

Identifier of Single Order Confirmation. Maximum length: 8.

confirmationGroup

confirmationGroup: string

Collective ID of Order Confirmations. Maximum length: 10.

Optional customer

customer: string

Account number of customer. Uniquely identifies a customer. This customer number is used for managing customer special stocks. Maximum length: 10.

nullable

Optional entryUnit

entryUnit: string

Unit of entry. Specifies the unit of measure in which the goods movement or inventory count is entered. Enter a unit of measure here only if it differs from the default unit of measure.There are the following default units of measure:the order unit for goods receipts with reference to purchase ordersthe production unit for goods receipts with reference to production ordersthe unit of issue for other goods movementsIf the default unit of measure has not been defined in the material master record, the system will suggest the stockkeeping unit. Maximum length: 3.

nullable

Optional goodsMovementRefDocType

goodsMovementRefDocType: string

Goods movement ref doc type. Maximum length: 1.

nullable

Optional goodsMovementType

goodsMovementType: string

Goods Movement Type. Maximum length: 3.

nullable

Optional inventorySpecialStockType

inventorySpecialStockType: string

Inventory Special Stock Type. Maximum length: 1.

nullable

Optional inventoryUsabilityCode

inventoryUsabilityCode: string

Inventory Usability Code. Maximum length: 1.

nullable

Optional inventoryValuationType

inventoryValuationType: string

Inventory Valuation Type. Maximum length: 10.

nullable

Optional isCompletelyDelivered

isCompletelyDelivered: boolean

"Delivery Completed" Indicator. Indicates that the item is to be regarded as closed.

nullable

Optional manufactureDate

manufactureDate: Moment

Date of Manufacture.

nullable

Optional material

material: string

Material Number for Order. Number of the material that is to be produced with this order. Maximum length: 40.

nullable

materialDocument

materialDocument: string

Number of Material Document. Alphanumeric key uniquely identifying the document. Number of the material document with which a goods movement was posted.Together with the material document year, the document number constitutes the key via which a material document is accessed. Maximum length: 10.

materialDocumentItem

materialDocumentItem: string

Item in Material Document. Specifies the number that uniquely identifies an item in . Maximum length: 4.

Optional materialDocumentItemText

materialDocumentItemText: string

Item Text. Contains an explanatory text on the line item. Line item texts can be used internally and externally. To be able to distinguish between these, you must begin texts for external use with "*". These texts can then be printed on all correspondence, dunning notices, payment advice notes, etc. The asterisk is removed when the text is printed.This function is only available in the FI component. It cannot be used in Materials Management. Maximum length: 50.

nullable

materialDocumentYear

materialDocumentYear: string

Material Document Year. Calendar year in which the material document was posted. In conjunction with the document number, the material document year constitutes the key via which a material document is accessed. Maximum length: 4.

Optional orderId

orderId: string

Manufacturing Order ID. Maximum length: 12.

nullable

Optional orderItem

orderItem: string

Order Item. Maximum length: 4.

nullable

Optional orderType

orderType: string

Manufacturing Order Type. Maximum length: 4.

nullable

Optional plant

plant: string

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

nullable

Optional quantityInEntryUnit

quantityInEntryUnit: BigNumber

Quantity in Unit of Entry.

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 reservation

reservation: string

Number of reservation/dependent requirements. Alphanumeric key uniquely identifying the document. Maximum length: 10.

nullable

Optional reservationIsFinallyIssued

reservationIsFinallyIssued: boolean

Final Issue for Reservation.

nullable

Optional reservationItem

reservationItem: string

Item Number of Reservation / Dependent Requirements. Maximum length: 4.

nullable

Optional salesOrder

salesOrder: string

Sales Order. Number of the sales order to which the order is to be settled. Maximum length: 10.

nullable

Optional salesOrderItem

salesOrderItem: string

Sales Order Item. Item in the sales order to which the order is to be settled. Maximum length: 6.

nullable

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 storageBin

storageBin: string

Storage Bin. The storage bin (sometimes referred to as a "slot") is the smallest addressable unit in a warehouse. It identifies the exact location in the warehouse where goods can be stored. A storage bin can be further sub-divided into bin sections. Several different materials (quants) can be stored in one bin at the same time. Maximum length: 10.

nullable

Optional storageLocation

storageLocation: string

Storage Location. Maximum length: 4.

nullable

Optional storageType

storageType: string

Storage Type. The storage type is a subdivision of a complex, physical warehouse. Different storage types are identified by their warehousing technique, form of organization, or their function. A typical warehouse could have the following storage types:Goods receipt areaPicking areaHigh-rack storage areaBulk storage areaOpen storage areaGoods issue area. Maximum length: 3.

nullable

Optional supplier

supplier: string

Vendor 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

versionIdentifier

versionIdentifier: string

ETag version identifier accessor.

returns

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

Optional wbsElementExternalId

wbsElementExternalId: string

Work Breakdown Structure Element (WBS Element) Edited. External 24-character name of an operative WBS element without a conversion routine stored in the domain. Maximum length: 24.

nullable

Static ALL_FIELDS

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

All fields selector.

Static BATCH

BATCH: StringField<ProcOrdConfMatlDocItm> = new StringField('Batch', ProcOrdConfMatlDocItm, '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 CONFIRMATION_COUNT

CONFIRMATION_COUNT: StringField<ProcOrdConfMatlDocItm> = new StringField('ConfirmationCount', ProcOrdConfMatlDocItm, 'Edm.String')

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

Static CONFIRMATION_GROUP

CONFIRMATION_GROUP: StringField<ProcOrdConfMatlDocItm> = new StringField('ConfirmationGroup', ProcOrdConfMatlDocItm, 'Edm.String')

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

Static CUSTOMER

CUSTOMER: StringField<ProcOrdConfMatlDocItm> = new StringField('Customer', ProcOrdConfMatlDocItm, 'Edm.String')

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

Static ENTRY_UNIT

ENTRY_UNIT: StringField<ProcOrdConfMatlDocItm> = new StringField('EntryUnit', ProcOrdConfMatlDocItm, 'Edm.String')

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

Static GOODS_MOVEMENT_REF_DOC_TYPE

GOODS_MOVEMENT_REF_DOC_TYPE: StringField<ProcOrdConfMatlDocItm> = new StringField('GoodsMovementRefDocType', ProcOrdConfMatlDocItm, 'Edm.String')

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

Static GOODS_MOVEMENT_TYPE

GOODS_MOVEMENT_TYPE: StringField<ProcOrdConfMatlDocItm> = new StringField('GoodsMovementType', ProcOrdConfMatlDocItm, 'Edm.String')

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

Static INVENTORY_SPECIAL_STOCK_TYPE

INVENTORY_SPECIAL_STOCK_TYPE: StringField<ProcOrdConfMatlDocItm> = new StringField('InventorySpecialStockType', ProcOrdConfMatlDocItm, 'Edm.String')

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

Static INVENTORY_USABILITY_CODE

INVENTORY_USABILITY_CODE: StringField<ProcOrdConfMatlDocItm> = new StringField('InventoryUsabilityCode', ProcOrdConfMatlDocItm, 'Edm.String')

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

Static INVENTORY_VALUATION_TYPE

INVENTORY_VALUATION_TYPE: StringField<ProcOrdConfMatlDocItm> = new StringField('InventoryValuationType', ProcOrdConfMatlDocItm, 'Edm.String')

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

Static IS_COMPLETELY_DELIVERED

IS_COMPLETELY_DELIVERED: BooleanField<ProcOrdConfMatlDocItm> = new BooleanField('IsCompletelyDelivered', ProcOrdConfMatlDocItm, 'Edm.Boolean')

Static representation of the isCompletelyDelivered 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<ProcOrdConfMatlDocItm> = new DateField('ManufactureDate', ProcOrdConfMatlDocItm, '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<ProcOrdConfMatlDocItm> = new StringField('Material', ProcOrdConfMatlDocItm, '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_DOCUMENT

MATERIAL_DOCUMENT: StringField<ProcOrdConfMatlDocItm> = new StringField('MaterialDocument', ProcOrdConfMatlDocItm, 'Edm.String')

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

Static MATERIAL_DOCUMENT_ITEM

MATERIAL_DOCUMENT_ITEM: StringField<ProcOrdConfMatlDocItm> = new StringField('MaterialDocumentItem', ProcOrdConfMatlDocItm, 'Edm.String')

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

Static MATERIAL_DOCUMENT_ITEM_TEXT

MATERIAL_DOCUMENT_ITEM_TEXT: StringField<ProcOrdConfMatlDocItm> = new StringField('MaterialDocumentItemText', ProcOrdConfMatlDocItm, 'Edm.String')

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

Static MATERIAL_DOCUMENT_YEAR

MATERIAL_DOCUMENT_YEAR: StringField<ProcOrdConfMatlDocItm> = new StringField('MaterialDocumentYear', ProcOrdConfMatlDocItm, 'Edm.String')

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

Static ORDER_ID

ORDER_ID: StringField<ProcOrdConfMatlDocItm> = new StringField('OrderID', ProcOrdConfMatlDocItm, 'Edm.String')

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

Static ORDER_ITEM

ORDER_ITEM: StringField<ProcOrdConfMatlDocItm> = new StringField('OrderItem', ProcOrdConfMatlDocItm, 'Edm.String')

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

Static ORDER_TYPE

ORDER_TYPE: StringField<ProcOrdConfMatlDocItm> = new StringField('OrderType', ProcOrdConfMatlDocItm, 'Edm.String')

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

Static PLANT

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

QUANTITY_IN_ENTRY_UNIT: BigNumberField<ProcOrdConfMatlDocItm> = new BigNumberField('QuantityInEntryUnit', ProcOrdConfMatlDocItm, 'Edm.Decimal')

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

Static RESERVATION

RESERVATION: StringField<ProcOrdConfMatlDocItm> = new StringField('Reservation', ProcOrdConfMatlDocItm, 'Edm.String')

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

Static RESERVATION_IS_FINALLY_ISSUED

RESERVATION_IS_FINALLY_ISSUED: BooleanField<ProcOrdConfMatlDocItm> = new BooleanField('ReservationIsFinallyIssued', ProcOrdConfMatlDocItm, 'Edm.Boolean')

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

Static RESERVATION_ITEM

RESERVATION_ITEM: StringField<ProcOrdConfMatlDocItm> = new StringField('ReservationItem', ProcOrdConfMatlDocItm, 'Edm.String')

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

Static SALES_ORDER

SALES_ORDER: StringField<ProcOrdConfMatlDocItm> = new StringField('SalesOrder', ProcOrdConfMatlDocItm, 'Edm.String')

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

Static SALES_ORDER_ITEM

SALES_ORDER_ITEM: StringField<ProcOrdConfMatlDocItm> = new StringField('SalesOrderItem', ProcOrdConfMatlDocItm, 'Edm.String')

Static representation of the salesOrderItem 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<ProcOrdConfMatlDocItm> = new DateField('ShelfLifeExpirationDate', ProcOrdConfMatlDocItm, '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 STORAGE_BIN

STORAGE_BIN: StringField<ProcOrdConfMatlDocItm> = new StringField('StorageBin', ProcOrdConfMatlDocItm, 'Edm.String')

Static representation of the storageBin 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<ProcOrdConfMatlDocItm> = new StringField('StorageLocation', ProcOrdConfMatlDocItm, '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 STORAGE_TYPE

STORAGE_TYPE: StringField<ProcOrdConfMatlDocItm> = new StringField('StorageType', ProcOrdConfMatlDocItm, 'Edm.String')

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

Static SUPPLIER

SUPPLIER: StringField<ProcOrdConfMatlDocItm> = new StringField('Supplier', ProcOrdConfMatlDocItm, '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 WBS_ELEMENT_EXTERNAL_ID

WBS_ELEMENT_EXTERNAL_ID: StringField<ProcOrdConfMatlDocItm> = new StringField('WBSElementExternalID', ProcOrdConfMatlDocItm, 'Edm.String')

Static representation of the wbsElementExternalId 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<ProcOrdConfMatlDocItm> | BooleanField<ProcOrdConfMatlDocItm> | DateField<ProcOrdConfMatlDocItm> | BigNumberField<ProcOrdConfMatlDocItm>> = [ProcOrdConfMatlDocItm.CONFIRMATION_GROUP,ProcOrdConfMatlDocItm.CONFIRMATION_COUNT,ProcOrdConfMatlDocItm.MATERIAL_DOCUMENT,ProcOrdConfMatlDocItm.MATERIAL_DOCUMENT_ITEM,ProcOrdConfMatlDocItm.MATERIAL_DOCUMENT_YEAR,ProcOrdConfMatlDocItm.ORDER_TYPE,ProcOrdConfMatlDocItm.ORDER_ID,ProcOrdConfMatlDocItm.ORDER_ITEM,ProcOrdConfMatlDocItm.MATERIAL,ProcOrdConfMatlDocItm.PLANT,ProcOrdConfMatlDocItm.RESERVATION,ProcOrdConfMatlDocItm.RESERVATION_ITEM,ProcOrdConfMatlDocItm.STORAGE_LOCATION,ProcOrdConfMatlDocItm.BATCH,ProcOrdConfMatlDocItm.INVENTORY_VALUATION_TYPE,ProcOrdConfMatlDocItm.GOODS_MOVEMENT_TYPE,ProcOrdConfMatlDocItm.GOODS_MOVEMENT_REF_DOC_TYPE,ProcOrdConfMatlDocItm.INVENTORY_USABILITY_CODE,ProcOrdConfMatlDocItm.INVENTORY_SPECIAL_STOCK_TYPE,ProcOrdConfMatlDocItm.SALES_ORDER,ProcOrdConfMatlDocItm.SALES_ORDER_ITEM,ProcOrdConfMatlDocItm.WBS_ELEMENT_EXTERNAL_ID,ProcOrdConfMatlDocItm.SUPPLIER,ProcOrdConfMatlDocItm.CUSTOMER,ProcOrdConfMatlDocItm.RESERVATION_IS_FINALLY_ISSUED,ProcOrdConfMatlDocItm.IS_COMPLETELY_DELIVERED,ProcOrdConfMatlDocItm.SHELF_LIFE_EXPIRATION_DATE,ProcOrdConfMatlDocItm.MANUFACTURE_DATE,ProcOrdConfMatlDocItm.STORAGE_TYPE,ProcOrdConfMatlDocItm.STORAGE_BIN,ProcOrdConfMatlDocItm.MATERIAL_DOCUMENT_ITEM_TEXT,ProcOrdConfMatlDocItm.ENTRY_UNIT,ProcOrdConfMatlDocItm.QUANTITY_IN_ENTRY_UNIT]

All fields of the ProcOrdConfMatlDocItm entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "ProcOrdConfMatlDocItm"

Technical entity name for ProcOrdConfMatlDocItm.

Static _keyFields

_keyFields: Array<Selectable<ProcOrdConfMatlDocItm>> = [ProcOrdConfMatlDocItm.CONFIRMATION_GROUP, ProcOrdConfMatlDocItm.CONFIRMATION_COUNT, ProcOrdConfMatlDocItm.MATERIAL_DOCUMENT, ProcOrdConfMatlDocItm.MATERIAL_DOCUMENT_ITEM, ProcOrdConfMatlDocItm.MATERIAL_DOCUMENT_YEAR]

All key fields of the ProcOrdConfMatlDocItm entity.

Static _keys

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

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

Static _serviceName

_serviceName: string = "API_PROC_ORDER_CONFIRMATION_2_SRV"
deprecated

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

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<ProcOrdConfMatlDocItm>

    A builder that constructs instances of entity type ProcOrdConfMatlDocItm.

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

    Returns ProcOrdConfMatlDocItmRequestBuilder

    A ProcOrdConfMatlDocItm request builder.