Options
All
  • Public
  • Public/Protected
  • All
Menu

This class represents the entity "A_BillOfMaterial" of service "API_BILL_OF_MATERIAL_SRV". This service is part of the following communication scenarios: Product Lifecycle Management - Master Data Integration (SAP_COM_0105). See https://api.sap.com/api/API_BILL_OF_MATERIAL_SRV for more information.

Hierarchy

  • Entity
    • BillOfMaterial

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns BillOfMaterial

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 billOfMaterial

billOfMaterial: string

Bill of Material. Number used in combination with the BOM category to uniquely identify a BOM or a BOM group. The system assigns this number internally. These numbers are irrelevant to the user. You access the BOM by entering the object (for example, material or equipment) to which the BOM belongs.The system stores the following information under this number:all alternatives in a multiple BOMall variants in a variant BOMBOMs that are allocated to more than one plant. Maximum length: 8.

nullable

Optional billOfMaterialAuthsnGrp

billOfMaterialAuthsnGrp: string

Authorization group for bills of material. This key is an authorization value, as stored in user profiles, which controls access to the BOM. In addition to the authorization group, the following values are checked for BOM transactions:- Transaction type- BOM usage- BOM categoryAssuming that the values in these other fields fulfil requirements, the authorization group controls checking as follows:If there is no entry, the authorization group of the user is not checked: any user can access the BOM.Otherwise, only those users whose user profile contains the authorization group entered can access the BOM.You can only enter authorization groups which fall within the range stored in your user profile. Maximum length: 4.

nullable

Optional billOfMaterialCategory

billOfMaterialCategory: string

BOM category. This key defines a BOM according to the object (such as material or equipment) to which it is linked. Material BOM - linked to a materialEquipment BOM - linked to an equipmentOrder BOM - linked to material, sales order and sales order item. Maximum length: 1.

nullable

billOfMaterialHeaderUuid

billOfMaterialHeaderUuid: string

Global identification of a BOM header change status.

Optional billOfMaterialStatus

billOfMaterialStatus: string

Bill of Material Status. Key which describes the current processing status of the BOM. This indicator controls subsequent processing of the BOM in various other organizational areas (for example, engineering, costing, MRP).1 - BOM activeThis BOM can, for example, be exploded in MRP and released for planned orders.2 - BOM not activeThis BOM cannot be processed as described above.In the modification table for BOM management, you can define a default status for creating BOMs. Maximum length: 2.

nullable

Optional billOfMaterialVariant

billOfMaterialVariant: string

Alternative BOM. Identifies one BOM in a BOM group. One product or assembly can be described by a number of (alternative) BOMs that represent, for example, different manufacturing processes for different lot sizes. These alternative BOMs are grouped together as one multiple BOM.Alternatives are maintained separately for each BOM usage. Maximum length: 2.

nullable

Optional billOfMaterialVariantUsage

billOfMaterialVariantUsage: string

BOM Usage. This key defines the area (such as engineering/design or production) where a BOM can be used. By setting various indicators, you can define the maximum configuration of the item status and define whether an item must be or cannot be processed in a particular area (such as production).A material is used in the areas production and costing in a company. For each area, you maintain a separate BOM with different items:Production BOM:This BOM contains items that are relevant to production. These items are copied to the planned order. Dependent requirements are generated for them, and they are copied to the production order.Costing BOM:This BOM contains items that are relevant to determining the material costs of a product.When you calculate production costs using a quantity structure, the system automatically determines the BOM and all the BOM items that are relevant to costing, in order to calculate manufacturing costs. Maximum length: 1.

nullable

Optional billOfMaterialVersion

billOfMaterialVersion: string

BOM Version. Maximum length: 4.

nullable

Optional bomAlternativeText

bomAlternativeText: string

Alternative BOM Text. This text describes an alternative and a variant. This information only applies to this individual alternative and variant.If you want to maintain a long text, choose the symbol to the right of the field. The system displays a different symbol for each situation:@0O@ Create long text@0Q@ Change long text@0P@ Display long text. Maximum length: 40.

nullable

Optional bomGroup

bomGroup: string

BOM group. Alphanumeric character string used to uniquely identify a BOM. If you assign a "meaningful" number to a BOM group, this gives you an additional way of accessing the BOM.The system stores the following under a BOM group:all the alternatives in a multiple BOMall the BOMs entered for a variant BOMThe following special characters are supported: - / _. Maximum length: 18.

nullable

Optional bomHeaderBaseUnit

bomHeaderBaseUnit: string

Base Unit of Measure for BOM. Unit of measure in which the base quantity of a product or assembly is entered. It is used as the base unit for all component quantities in this BOM. The system takes this unit from the material master.The unit cannot be changed, because stock of the material is managed using this unit. Maximum length: 3.

nullable

Optional bomHeaderInternalChangeCount

bomHeaderInternalChangeCount: string

Internal counter. Identifies the activity posting. Maximum length: 8.

nullable

Optional bomHeaderQuantityInBaseUnit

bomHeaderQuantityInBaseUnit: BigNumber

Base quantity. Quantity to which all component quantities in a BOM relate. Using this customizing function, you can define a value which is set as a default when you create a bill of material.

nullable

Optional bomHeaderText

bomHeaderText: string

BOM Description. Short text which describes the whole BOM. It contains information, whichapplies to all the alternatives in a BOMapplies to all the variants in a variant BOMIf you want to maintain a long text, choose the symbol to the right of the field. The system displays different symbols according to the situation:@0O@ Create longtext@0Q@ Change longtext@0P@ Display longtext. Maximum length: 40.

nullable

Optional bomIsToBeDeleted

bomIsToBeDeleted: string

Handling Deletion Flag During BOM Explosion. Maximum length: 1.

nullable

Optional bomTechnicalType

bomTechnicalType: string

Technical type. Categorization of BOMs according to how they represent different product variants and production variants. You can extend a simple BOM to form one of the following:multiple BOMvariant BOMThe system allocates technical types:according to the number of alternative BOMsWhen you create the first alternative for a BOM, the technical type is not yet defined. If you extend the BOM by creating an alternative, the system automatically assigns the technical type multiple BOM.according to the transactionIf you create a BOM using the Create variant of... function, the system assigns the technical type variant BOM. After this, you can no longer create alternatives for the BOM.Multiple BOM - MOne product can be produced according to different manufacturing processes from different components and component quantities: one product has more than one alternative BOM.----------| ------ |--------|--|ALT1| |---- | | ------ ||MAT1|--| | |---- | | ------ |--------|--|ALT2| || ------ |----------Variant BOM - VA number of similar products are described via one BOM. Each product has one alternative BOM.---- ----------|MAT1|--.........|.. |---- | | ------ ||--------| |ALT1| |---- | | ------ ||MAT2|--.........|.. |---- ----------. Maximum length: 1.

nullable

Optional bomUsagePriority

bomUsagePriority: string

CIM priority for selection ID. This key defines the order of priority of BOM usages for computer integrated production. When a BOM is exploded, priority is given to the alternative that has the greatest available significance according to the order of priority defined for the selection ID.If no valid BOM is found for any of the usages defined in the order of priority, there is no BOM explosion.You maintain selection ID 05, to be used for alternative determination in sales and distribution. BOM usage 'sales' (4) has the highest priority, followed by 'production' (2).The settings for this example are as follows:Selection Selection BOMID priority usage05 1 405 2 2When you define the application for sales and distribution (application SLDB) in step 'Define applications', allocate selection ID 05 to application SLDB. Maximum length: 2.

nullable

Optional bomVersionStatus

bomVersionStatus: string

BOM Version Status. Maximum length: 2.

nullable

Optional chgToEngineeringChgDocument

chgToEngineeringChgDocument: string

Change Number To. Number used to identify the change master, which will determine the subsequent validity period of the object (material, for example). If the object has been changed using a change number, the system determines this change number automatically.Three change numbers (N1, N2 and N3) define the validity periods of the item:N1 N2 N3I-----------I----------------------I---------------->1.1.96 6.1.96 12.2.96If you change the item within the validity period of change number N1, the system enters N2 in Change number to.If you change the item within the validity period of change number N2, the system enters N3 in Change number to. Maximum length: 12.

nullable

Optional createdByUser

createdByUser: string

User who created record. Name of user who created the record. Maximum length: 12.

nullable

Optional documentIsCreatedByCad

documentIsCreatedByCad: boolean

CAD Indicator. This indicator shows that the object (such as BOM or document) was created or changed in a CAD system. Data transfer in the SAP system via CAD interface. This indicator is only for information.However you can use it as search criteria for a document search. You can restrict the document search as follows:Entry DescriptionX find documents with a CAD indicatorfind documents without a CAD indicator* find documents with or without a CAD indicatorThis indicator is set using the CAD interface.

nullable

Optional engineeringChangeDocForEdit

engineeringChangeDocForEdit: string

Change Number. Number used to uniquely identify a change master record. If you make a change with reference to a change number, or create anobject with a change number, the following functions are at your disposal:The system determines the effectivity parametersThe conditions that the change is effective under can be defined in the change master record as follows:Changes with a date effectivity (valid from date)Changes with parameter effectivity (for example: serial no. effectivity)Log of the changes madeDocumentation for the changesRevision level to indicate the change status of a material or documentChanges released for the different areas in the company. Maximum length: 12.

nullable

Optional engineeringChangeDocument

engineeringChangeDocument: string

Change Number. Number used to uniquely identify a change master record. If you make a change with reference to a change number, or create anobject with a change number, the following functions are at your disposal:The system determines the effectivity parametersThe conditions that the change is effective under can be defined in the change master record as follows:Changes with a date effectivity (valid from date)Changes with parameter effectivity (for example: serial no. effectivity)Log of the changes madeDocumentation for the changesRevision level to indicate the change status of a material or documentChanges released for the different areas in the company. Maximum length: 12.

nullable

Optional headerValidityEndDate

headerValidityEndDate: Moment

Valid-to date. End of validity period of an object (such as material, BOM, or routing) in the SAP System.

nullable

Optional headerValidityStartDate

headerValidityStartDate: Moment

Valid-From Date. Specifies the start date for the validity period of an object (such as material, BOM, or routing).

nullable

Optional isAle

isAle: boolean

ALE indicator. Shows that data of the assembly or component has been distributed to the SAP system using ALE.

nullable

Optional isConfiguredMaterial

isConfiguredMaterial: boolean

Indicator: configurable BOM. This indicator shows that configurable assemblies (assemblies that can be put together from different combinations of components) are allowed. Configurable assemblies:are used in sales variant processingcontain selectable parts, which are used alongside non-variable parts in the variant to be produced.

nullable

Optional isLatestBomVersion

isLatestBomVersion: boolean

Indicator: Latest BOM Version.

nullable

Optional isMarkedForDeletion

isMarkedForDeletion: boolean

Deletion Indicator. Indicator showing that the BOM header or the BOM item has been deleted with reference to the change number. This indicator is relevant to changes that have been made with reference to a change number with a validity that has been specified using a new validity type.

nullable

Optional isMultipleBomAlt

isMultipleBomAlt: boolean

Indicator: alternative determination for multiple BOMs. When alternatives are selected automatically according to application, this indicator determines that the SAP System is to select a specific alternative as of a certain date. You define for which multiple BOM (material/plant/usage) and from which date the specific alternative is to be selected in the IMG for Production (BOMs). To do this, choose BOMs -> Alternative Determination -> Define alternative determination for multiple BOMs step.

nullable

Optional isVersionBillOfMaterial

isVersionBillOfMaterial: boolean

Indicator: Relevant for versioning.

nullable

Optional laboratoryOrDesignOffice

laboratoryOrDesignOffice: string

Laboratory/design office. Key for the design office, laboratory, or laboratory worker responsible. You define the keys in Customizing (for the Material Master). Maximum length: 3.

nullable

Optional lastChangeDate

lastChangeDate: Moment

Date of Last Change.

nullable

Optional lastChangedByUser

lastChangedByUser: string

Name of Person who Changed Object. Maximum length: 12.

nullable

Optional material

material: string

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

nullable

Optional plant

plant: string

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

nullable

Optional recordCreationDate

recordCreationDate: Moment

Date Record Created On. Date on which the record was created.

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 selectedBillOfMaterialVersion

selectedBillOfMaterialVersion: string

Selected Bill Of Material Version. Maximum length: 4.

nullable

toBillOfMaterialItem

toBillOfMaterialItem: BillOfMaterialItem[]

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

toBillOfMaterialUsage

toBillOfMaterialUsage: BillOfMaterialUsage

One-to-one navigation property to the BillOfMaterialUsage 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<BillOfMaterial> = new AllFields('*', BillOfMaterial)

All fields selector.

Static BILL_OF_MATERIAL

BILL_OF_MATERIAL: StringField<BillOfMaterial> = new StringField('BillOfMaterial', BillOfMaterial, 'Edm.String')

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

Static BILL_OF_MATERIAL_AUTHSN_GRP

BILL_OF_MATERIAL_AUTHSN_GRP: StringField<BillOfMaterial> = new StringField('BillOfMaterialAuthsnGrp', BillOfMaterial, 'Edm.String')

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

Static BILL_OF_MATERIAL_CATEGORY

BILL_OF_MATERIAL_CATEGORY: StringField<BillOfMaterial> = new StringField('BillOfMaterialCategory', BillOfMaterial, 'Edm.String')

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

Static BILL_OF_MATERIAL_HEADER_UUID

BILL_OF_MATERIAL_HEADER_UUID: StringField<BillOfMaterial> = new StringField('BillOfMaterialHeaderUUID', BillOfMaterial, 'Edm.Guid')

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

Static BILL_OF_MATERIAL_STATUS

BILL_OF_MATERIAL_STATUS: StringField<BillOfMaterial> = new StringField('BillOfMaterialStatus', BillOfMaterial, 'Edm.String')

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

Static BILL_OF_MATERIAL_VARIANT

BILL_OF_MATERIAL_VARIANT: StringField<BillOfMaterial> = new StringField('BillOfMaterialVariant', BillOfMaterial, 'Edm.String')

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

Static BILL_OF_MATERIAL_VARIANT_USAGE

BILL_OF_MATERIAL_VARIANT_USAGE: StringField<BillOfMaterial> = new StringField('BillOfMaterialVariantUsage', BillOfMaterial, 'Edm.String')

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

Static BILL_OF_MATERIAL_VERSION

BILL_OF_MATERIAL_VERSION: StringField<BillOfMaterial> = new StringField('BillOfMaterialVersion', BillOfMaterial, 'Edm.String')

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

Static BOM_ALTERNATIVE_TEXT

BOM_ALTERNATIVE_TEXT: StringField<BillOfMaterial> = new StringField('BOMAlternativeText', BillOfMaterial, 'Edm.String')

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

Static BOM_GROUP

BOM_GROUP: StringField<BillOfMaterial> = new StringField('BOMGroup', BillOfMaterial, 'Edm.String')

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

Static BOM_HEADER_BASE_UNIT

BOM_HEADER_BASE_UNIT: StringField<BillOfMaterial> = new StringField('BOMHeaderBaseUnit', BillOfMaterial, 'Edm.String')

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

Static BOM_HEADER_INTERNAL_CHANGE_COUNT

BOM_HEADER_INTERNAL_CHANGE_COUNT: StringField<BillOfMaterial> = new StringField('BOMHeaderInternalChangeCount', BillOfMaterial, 'Edm.String')

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

Static BOM_HEADER_QUANTITY_IN_BASE_UNIT

BOM_HEADER_QUANTITY_IN_BASE_UNIT: BigNumberField<BillOfMaterial> = new BigNumberField('BOMHeaderQuantityInBaseUnit', BillOfMaterial, 'Edm.Decimal')

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

Static BOM_HEADER_TEXT

BOM_HEADER_TEXT: StringField<BillOfMaterial> = new StringField('BOMHeaderText', BillOfMaterial, 'Edm.String')

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

Static BOM_IS_TO_BE_DELETED

BOM_IS_TO_BE_DELETED: StringField<BillOfMaterial> = new StringField('BOMIsToBeDeleted', BillOfMaterial, 'Edm.String')

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

Static BOM_TECHNICAL_TYPE

BOM_TECHNICAL_TYPE: StringField<BillOfMaterial> = new StringField('BOMTechnicalType', BillOfMaterial, 'Edm.String')

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

Static BOM_USAGE_PRIORITY

BOM_USAGE_PRIORITY: StringField<BillOfMaterial> = new StringField('BOMUsagePriority', BillOfMaterial, 'Edm.String')

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

Static BOM_VERSION_STATUS

BOM_VERSION_STATUS: StringField<BillOfMaterial> = new StringField('BOMVersionStatus', BillOfMaterial, 'Edm.String')

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

Static CHG_TO_ENGINEERING_CHG_DOCUMENT

CHG_TO_ENGINEERING_CHG_DOCUMENT: StringField<BillOfMaterial> = new StringField('ChgToEngineeringChgDocument', BillOfMaterial, 'Edm.String')

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

Static CREATED_BY_USER

CREATED_BY_USER: StringField<BillOfMaterial> = new StringField('CreatedByUser', BillOfMaterial, 'Edm.String')

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

Static DOCUMENT_IS_CREATED_BY_CAD

DOCUMENT_IS_CREATED_BY_CAD: BooleanField<BillOfMaterial> = new BooleanField('DocumentIsCreatedByCAD', BillOfMaterial, 'Edm.Boolean')

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

Static ENGINEERING_CHANGE_DOCUMENT

ENGINEERING_CHANGE_DOCUMENT: StringField<BillOfMaterial> = new StringField('EngineeringChangeDocument', BillOfMaterial, 'Edm.String')

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

Static ENGINEERING_CHANGE_DOC_FOR_EDIT

ENGINEERING_CHANGE_DOC_FOR_EDIT: StringField<BillOfMaterial> = new StringField('EngineeringChangeDocForEdit', BillOfMaterial, 'Edm.String')

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

Static HEADER_VALIDITY_END_DATE

HEADER_VALIDITY_END_DATE: DateField<BillOfMaterial> = new DateField('HeaderValidityEndDate', BillOfMaterial, 'Edm.DateTime')

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

Static HEADER_VALIDITY_START_DATE

HEADER_VALIDITY_START_DATE: DateField<BillOfMaterial> = new DateField('HeaderValidityStartDate', BillOfMaterial, 'Edm.DateTime')

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

Static IS_ALE

IS_ALE: BooleanField<BillOfMaterial> = new BooleanField('IsALE', BillOfMaterial, 'Edm.Boolean')

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

Static IS_CONFIGURED_MATERIAL

IS_CONFIGURED_MATERIAL: BooleanField<BillOfMaterial> = new BooleanField('IsConfiguredMaterial', BillOfMaterial, 'Edm.Boolean')

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

Static IS_LATEST_BOM_VERSION

IS_LATEST_BOM_VERSION: BooleanField<BillOfMaterial> = new BooleanField('IsLatestBOMVersion', BillOfMaterial, 'Edm.Boolean')

Static representation of the isLatestBomVersion 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<BillOfMaterial> = new BooleanField('IsMarkedForDeletion', BillOfMaterial, '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 IS_MULTIPLE_BOM_ALT

IS_MULTIPLE_BOM_ALT: BooleanField<BillOfMaterial> = new BooleanField('IsMultipleBOMAlt', BillOfMaterial, 'Edm.Boolean')

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

Static IS_VERSION_BILL_OF_MATERIAL

IS_VERSION_BILL_OF_MATERIAL: BooleanField<BillOfMaterial> = new BooleanField('IsVersionBillOfMaterial', BillOfMaterial, 'Edm.Boolean')

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

Static LABORATORY_OR_DESIGN_OFFICE

LABORATORY_OR_DESIGN_OFFICE: StringField<BillOfMaterial> = new StringField('LaboratoryOrDesignOffice', BillOfMaterial, 'Edm.String')

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

Static LAST_CHANGED_BY_USER

LAST_CHANGED_BY_USER: StringField<BillOfMaterial> = new StringField('LastChangedByUser', BillOfMaterial, 'Edm.String')

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

Static LAST_CHANGE_DATE

LAST_CHANGE_DATE: DateField<BillOfMaterial> = new DateField('LastChangeDate', BillOfMaterial, 'Edm.DateTime')

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

Static MATERIAL

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

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

RECORD_CREATION_DATE: DateField<BillOfMaterial> = new DateField('RecordCreationDate', BillOfMaterial, 'Edm.DateTime')

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

Static SELECTED_BILL_OF_MATERIAL_VERSION

SELECTED_BILL_OF_MATERIAL_VERSION: StringField<BillOfMaterial> = new StringField('SelectedBillOfMaterialVersion', BillOfMaterial, 'Edm.String')

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

Static TO_BILL_OF_MATERIAL_ITEM

TO_BILL_OF_MATERIAL_ITEM: Link<BillOfMaterial, BillOfMaterialItem> = new Link('to_BillOfMaterialItem', BillOfMaterial, BillOfMaterialItem)

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

Static TO_BILL_OF_MATERIAL_USAGE

TO_BILL_OF_MATERIAL_USAGE: OneToOneLink<BillOfMaterial, BillOfMaterialUsage> = new OneToOneLink('to_BillOfMaterialUsage', BillOfMaterial, BillOfMaterialUsage)

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

Static _allFields

_allFields: Array<StringField<BillOfMaterial> | BooleanField<BillOfMaterial> | DateField<BillOfMaterial> | BigNumberField<BillOfMaterial> | Link<BillOfMaterial, BillOfMaterialItem> | OneToOneLink<BillOfMaterial, BillOfMaterialUsage>> = [BillOfMaterial.BILL_OF_MATERIAL_HEADER_UUID,BillOfMaterial.BILL_OF_MATERIAL_VARIANT_USAGE,BillOfMaterial.BILL_OF_MATERIAL_CATEGORY,BillOfMaterial.BILL_OF_MATERIAL,BillOfMaterial.BILL_OF_MATERIAL_VARIANT,BillOfMaterial.MATERIAL,BillOfMaterial.PLANT,BillOfMaterial.IS_MULTIPLE_BOM_ALT,BillOfMaterial.BOM_HEADER_INTERNAL_CHANGE_COUNT,BillOfMaterial.BOM_USAGE_PRIORITY,BillOfMaterial.BILL_OF_MATERIAL_AUTHSN_GRP,BillOfMaterial.BILL_OF_MATERIAL_VERSION,BillOfMaterial.BOM_VERSION_STATUS,BillOfMaterial.IS_VERSION_BILL_OF_MATERIAL,BillOfMaterial.IS_LATEST_BOM_VERSION,BillOfMaterial.IS_CONFIGURED_MATERIAL,BillOfMaterial.BOM_TECHNICAL_TYPE,BillOfMaterial.BOM_GROUP,BillOfMaterial.BOM_HEADER_TEXT,BillOfMaterial.BOM_ALTERNATIVE_TEXT,BillOfMaterial.BILL_OF_MATERIAL_STATUS,BillOfMaterial.HEADER_VALIDITY_START_DATE,BillOfMaterial.HEADER_VALIDITY_END_DATE,BillOfMaterial.ENGINEERING_CHANGE_DOC_FOR_EDIT,BillOfMaterial.ENGINEERING_CHANGE_DOCUMENT,BillOfMaterial.CHG_TO_ENGINEERING_CHG_DOCUMENT,BillOfMaterial.IS_MARKED_FOR_DELETION,BillOfMaterial.IS_ALE,BillOfMaterial.BOM_HEADER_BASE_UNIT,BillOfMaterial.BOM_HEADER_QUANTITY_IN_BASE_UNIT,BillOfMaterial.RECORD_CREATION_DATE,BillOfMaterial.LAST_CHANGE_DATE,BillOfMaterial.CREATED_BY_USER,BillOfMaterial.LAST_CHANGED_BY_USER,BillOfMaterial.BOM_IS_TO_BE_DELETED,BillOfMaterial.DOCUMENT_IS_CREATED_BY_CAD,BillOfMaterial.LABORATORY_OR_DESIGN_OFFICE,BillOfMaterial.SELECTED_BILL_OF_MATERIAL_VERSION,BillOfMaterial.TO_BILL_OF_MATERIAL_ITEM,BillOfMaterial.TO_BILL_OF_MATERIAL_USAGE]

All fields of the BillOfMaterial entity.

Static _defaultServicePath

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

Default url path for the according service.

Static _entityName

_entityName: string = "A_BillOfMaterial"

Technical entity name for BillOfMaterial.

Static _keyFields

_keyFields: Array<Selectable<BillOfMaterial>> = [BillOfMaterial.BILL_OF_MATERIAL_HEADER_UUID]

All key fields of the BillOfMaterial entity.

Static _keys

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

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

Static _serviceName

_serviceName: string = "API_BILL_OF_MATERIAL_SRV"
deprecated

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

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

    Returns EntityBuilderType<BillOfMaterial, BillOfMaterialType>

    A builder that constructs instances of entity type BillOfMaterial.

Static customField

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

    Parameters

    • fieldName: string

      Name of the custom field to select

    Returns CustomField<BillOfMaterial>

    A builder that constructs instances of entity type BillOfMaterial.

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

    Returns BillOfMaterialRequestBuilder

    A BillOfMaterial request builder.