@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultBillOfMaterialsService") public class DefaultBillOfMaterialsService extends Object implements BillOfMaterialsService
This asynchronous inbound service enables you to read, create and update and Delete Bills of Material and Version Bills of Material. It is based on the OData protocol and can be consumed in SAP Fiori apps and on other user interfaces. The service contains either no header, one header or multiple headers for the specified material and zero or more items for each header. .
Reference: SAP API Business Hub
OData Service: | API_BILL_OF_MATERIAL_SRV |
API Version: | 2 |
Communication Scenario: | Product Lifecycle Management - Master Data Integration (SAP_COM_0105) |
Scope Items: | Engineering Bill of Material - Versions Management (1NR), Engineering Bill of Material - Change Master Management (1R3) |
Authentication Methods: | Basic, x509 |
DEFAULT_SERVICE_PATH
Constructor and Description |
---|
DefaultBillOfMaterialsService()
Creates a service using
BillOfMaterialsService.DEFAULT_SERVICE_PATH to send the requests. |
Modifier and Type | Method and Description |
---|---|
MaterialBOMCreateFluentHelper |
createMaterialBOM(MaterialBOM materialBOM)
Create a new
MaterialBOM
entity and save it to the S/4HANA system. |
MaterialBOMItemCreateFluentHelper |
createMaterialBOMItem(MaterialBOMItem materialBOMItem)
Create a new
MaterialBOMItem entity and save it to the S/4HANA system. |
MaterialBOMDeleteFluentHelper |
deleteMaterialBOM(MaterialBOM materialBOM)
Deletes an existing
MaterialBOM entity in the S/4HANA system. |
MaterialBOMItemDeleteFluentHelper |
deleteMaterialBOMItem(MaterialBOMItem materialBOMItem)
Deletes an existing
MaterialBOMItem entity in the S/4HANA system. |
ExplodeBOMFluentHelper |
explodeBOM(String billOfMaterial,
String billOfMaterialCategory,
String billOfMaterialVariant,
String billOfMaterialVersion,
String engineeringChangeDocument,
String material,
String plant,
String bOMExplosionApplication,
BigDecimal requiredQuantity,
Boolean bOMExplosionIsLimited,
String bOMItmQtyIsScrapRelevant,
String billOfMaterialItemCategory,
String bOMExplosionAssembly,
LocalDateTime bOMExplosionDate,
BigDecimal bOMExplosionLevel,
Boolean bOMExplosionIsMultilevel,
String materialProvisionFltrType,
String sparePartFltrType)
Creates a fluent helper for the ExplodeBOM OData function import.
|
BillOfMaterialUsageFluentHelper |
getAllBillOfMaterialUsage()
Fetch multiple
BillOfMaterialUsage entities. |
BillOfMaterialUsageTextFluentHelper |
getAllBillOfMaterialUsageText()
Fetch multiple
BillOfMaterialUsageText entities. |
BOMItemCategoryFluentHelper |
getAllBOMItemCategory()
Fetch multiple
BOMItemCategory entities. |
BOMItemCategoryTextFluentHelper |
getAllBOMItemCategoryText()
Fetch multiple
BOMItemCategoryText entities. |
MaterialBOMFluentHelper |
getAllMaterialBOM()
Fetch multiple
MaterialBOM entities. |
MaterialBOMItemFluentHelper |
getAllMaterialBOMItem()
Fetch multiple
MaterialBOMItem entities. |
BillOfMaterialUsageByKeyFluentHelper |
getBillOfMaterialUsageByKey(String billOfMaterialVariantUsage)
Fetch a single
BillOfMaterialUsage entity using key fields. |
BillOfMaterialUsageTextByKeyFluentHelper |
getBillOfMaterialUsageTextByKey(String language,
String billOfMaterialVariantUsage)
Fetch a single
BillOfMaterialUsageText entity using key fields. |
BOMItemCategoryByKeyFluentHelper |
getBOMItemCategoryByKey(String billOfMaterialItemCategory)
Fetch a single
BOMItemCategory entity using key fields. |
BOMItemCategoryTextByKeyFluentHelper |
getBOMItemCategoryTextByKey(String language,
String billOfMaterialItemCategory)
Fetch a single
BOMItemCategoryText entity using key fields. |
MaterialBOMByKeyFluentHelper |
getMaterialBOMByKey(String billOfMaterial,
String billOfMaterialCategory,
String billOfMaterialVariant,
String billOfMaterialVersion,
String engineeringChangeDocument,
String material,
String plant)
Fetch a single
MaterialBOM entity using key fields. |
MaterialBOMItemByKeyFluentHelper |
getMaterialBOMItemByKey(String billOfMaterial,
String billOfMaterialCategory,
String billOfMaterialVariant,
String billOfMaterialVersion,
String billOfMaterialItemNodeNumber,
String headerChangeDocument,
String material,
String plant)
Fetch a single
MaterialBOMItem entity using key fields. |
ReleaseVersionBOMFluentHelper |
releaseVersionBOM(String billOfMaterial,
String billOfMaterialCategory,
String billOfMaterialVariant,
String billOfMaterialVersion,
String engineeringChangeDocument,
String material,
String plant)
Creates a fluent helper for the ReleaseVersionBOM OData function import.
|
MaterialBOMUpdateFluentHelper |
updateMaterialBOM(MaterialBOM materialBOM)
Update an existing
MaterialBOM entity and save it to the S/4HANA system. |
MaterialBOMItemUpdateFluentHelper |
updateMaterialBOMItem(MaterialBOMItem materialBOMItem)
Update an existing
MaterialBOMItem entity and save it to the S/4HANA system. |
DefaultBillOfMaterialsService |
withServicePath(String servicePath)
Overrides the default service path and returns a new service instance with the specified service path.
|
public DefaultBillOfMaterialsService()
BillOfMaterialsService.DEFAULT_SERVICE_PATH
to send the requests.@Nonnull public DefaultBillOfMaterialsService withServicePath(@Nonnull String servicePath)
BillOfMaterialsService
withServicePath
in interface BillOfMaterialsService
servicePath
- Service path that will override the default.@Nonnull public MaterialBOMItemFluentHelper getAllMaterialBOMItem()
BillOfMaterialsService
MaterialBOMItem
entities.getAllMaterialBOMItem
in interface BillOfMaterialsService
MaterialBOMItem
entities. This fluent helper allows methods which modify the underlying query to be
called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public MaterialBOMItemByKeyFluentHelper getMaterialBOMItemByKey(String billOfMaterial, String billOfMaterialCategory, String billOfMaterialVariant, String billOfMaterialVersion, String billOfMaterialItemNodeNumber, String headerChangeDocument, String material, String plant)
BillOfMaterialsService
MaterialBOMItem
entity using key fields.getMaterialBOMItemByKey
in interface BillOfMaterialsService
billOfMaterial
- Number used in combination with the BOM category to uniquely identify a BOM or a BOM group.
Constraints: Not nullable, Maximum length: 8
billOfMaterialCategory
- This key defines a BOM according to the object (such as material or equipment) to which it is linked.
Constraints: Not nullable, Maximum length: 1
billOfMaterialVariant
- Identifies one BOM in a BOM group.
Constraints: Not nullable, Maximum length: 2
billOfMaterialVersion
- BOM Version
Constraints: Not nullable, Maximum length: 4
headerChangeDocument
- Number used to uniquely identify a change master record.
Constraints: Not nullable, Maximum length: 12
material
- Alphanumeric key uniquely identifying the material.
Constraints: Not nullable, Maximum length: 40
plant
- Key uniquely identifying a plant.
Constraints: Not nullable, Maximum length: 4
MaterialBOMItem
entity using key fields. This fluent helper allows methods which modify the underlying
query to be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public MaterialBOMItemCreateFluentHelper createMaterialBOMItem(@Nonnull MaterialBOMItem materialBOMItem)
BillOfMaterialsService
MaterialBOMItem
entity and save it to the S/4HANA system.createMaterialBOMItem
in interface BillOfMaterialsService
materialBOMItem
- MaterialBOMItem
entity object that will be created in the S/4HANA system.MaterialBOMItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public MaterialBOMItemUpdateFluentHelper updateMaterialBOMItem(@Nonnull MaterialBOMItem materialBOMItem)
BillOfMaterialsService
MaterialBOMItem
entity and save it to the S/4HANA system.updateMaterialBOMItem
in interface BillOfMaterialsService
materialBOMItem
- MaterialBOMItem
entity object that will be updated in the S/4HANA system.MaterialBOMItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public MaterialBOMItemDeleteFluentHelper deleteMaterialBOMItem(@Nonnull MaterialBOMItem materialBOMItem)
BillOfMaterialsService
MaterialBOMItem
entity in the S/4HANA system.deleteMaterialBOMItem
in interface BillOfMaterialsService
materialBOMItem
- MaterialBOMItem
entity object that will be deleted in the S/4HANA system.MaterialBOMItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public BillOfMaterialUsageFluentHelper getAllBillOfMaterialUsage()
BillOfMaterialsService
BillOfMaterialUsage
entities.getAllBillOfMaterialUsage
in interface BillOfMaterialsService
BillOfMaterialUsage
entities. This fluent helper allows methods which modify the underlying query to be
called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public BillOfMaterialUsageByKeyFluentHelper getBillOfMaterialUsageByKey(String billOfMaterialVariantUsage)
BillOfMaterialsService
BillOfMaterialUsage
entity using key fields.getBillOfMaterialUsageByKey
in interface BillOfMaterialsService
billOfMaterialVariantUsage
- This key defines the area (such as engineering/design or production) where a BOM can be used.
Constraints: Not nullable, Maximum length: 1
BillOfMaterialUsage
entity using key fields. This fluent helper allows methods which modify the
underlying query to be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public BillOfMaterialUsageTextFluentHelper getAllBillOfMaterialUsageText()
BillOfMaterialsService
BillOfMaterialUsageText
entities.getAllBillOfMaterialUsageText
in interface BillOfMaterialsService
BillOfMaterialUsageText
entities. This fluent helper allows methods which modify the underlying query to
be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public BillOfMaterialUsageTextByKeyFluentHelper getBillOfMaterialUsageTextByKey(String language, String billOfMaterialVariantUsage)
BillOfMaterialsService
BillOfMaterialUsageText
entity using key fields.getBillOfMaterialUsageTextByKey
in interface BillOfMaterialsService
language
- The language key indicates
Constraints: Not nullable, Maximum length: 2
billOfMaterialVariantUsage
- This key defines the area (such as engineering/design or production) where a BOM can be used.
Constraints: Not nullable, Maximum length: 1
BillOfMaterialUsageText
entity using key fields. This fluent helper allows methods which modify the
underlying query to be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public MaterialBOMFluentHelper getAllMaterialBOM()
BillOfMaterialsService
MaterialBOM
entities.getAllMaterialBOM
in interface BillOfMaterialsService
MaterialBOM
entities. This fluent helper allows methods which modify the underlying query to be called before
executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public MaterialBOMByKeyFluentHelper getMaterialBOMByKey(String billOfMaterial, String billOfMaterialCategory, String billOfMaterialVariant, String billOfMaterialVersion, String engineeringChangeDocument, String material, String plant)
BillOfMaterialsService
MaterialBOM
entity using key fields.getMaterialBOMByKey
in interface BillOfMaterialsService
billOfMaterial
- Number used in combination with the BOM category to uniquely identify a BOM or a BOM group.
Constraints: Not nullable, Maximum length: 8
billOfMaterialCategory
- This key defines a BOM according to the object (such as material or equipment) to which it is linked.
Constraints: Not nullable, Maximum length: 1
billOfMaterialVariant
- Identifies one BOM in a BOM group.
Constraints: Not nullable, Maximum length: 2
billOfMaterialVersion
- BOM Version
Constraints: Not nullable, Maximum length: 4
engineeringChangeDocument
- Number used to uniquely identify a change master record.
Constraints: Not nullable, Maximum length: 12
material
- Alphanumeric key uniquely identifying the material.
Constraints: Not nullable, Maximum length: 40
plant
- Key uniquely identifying a plant.
Constraints: Not nullable, Maximum length: 4
MaterialBOM
entity using key fields. This fluent helper allows methods which modify the underlying query to be called
before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public MaterialBOMCreateFluentHelper createMaterialBOM(@Nonnull MaterialBOM materialBOM)
BillOfMaterialsService
MaterialBOM
entity and save it to the S/4HANA system.createMaterialBOM
in interface BillOfMaterialsService
materialBOM
- MaterialBOM
entity object that will be created in the S/4HANA system.MaterialBOM
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public MaterialBOMUpdateFluentHelper updateMaterialBOM(@Nonnull MaterialBOM materialBOM)
BillOfMaterialsService
MaterialBOM
entity and save it to the S/4HANA system.updateMaterialBOM
in interface BillOfMaterialsService
materialBOM
- MaterialBOM
entity object that will be updated in the S/4HANA system.MaterialBOM
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public MaterialBOMDeleteFluentHelper deleteMaterialBOM(@Nonnull MaterialBOM materialBOM)
BillOfMaterialsService
MaterialBOM
entity in the S/4HANA system.deleteMaterialBOM
in interface BillOfMaterialsService
materialBOM
- MaterialBOM
entity object that will be deleted in the S/4HANA system.MaterialBOM
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public BOMItemCategoryFluentHelper getAllBOMItemCategory()
BillOfMaterialsService
BOMItemCategory
entities.getAllBOMItemCategory
in interface BillOfMaterialsService
BOMItemCategory
entities. This fluent helper allows methods which modify the underlying query to be
called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public BOMItemCategoryByKeyFluentHelper getBOMItemCategoryByKey(String billOfMaterialItemCategory)
BillOfMaterialsService
BOMItemCategory
entity using key fields.getBOMItemCategoryByKey
in interface BillOfMaterialsService
billOfMaterialItemCategory
- Categorization of the items in a BOM according to set criteria, such as whether they refer to an
object (for example, material master or document info record) or whether they are kept in stock.
Constraints: Not nullable, Maximum length: 1
BOMItemCategory
entity using key fields. This fluent helper allows methods which modify the underlying
query to be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public BOMItemCategoryTextFluentHelper getAllBOMItemCategoryText()
BillOfMaterialsService
BOMItemCategoryText
entities.getAllBOMItemCategoryText
in interface BillOfMaterialsService
BOMItemCategoryText
entities. This fluent helper allows methods which modify the underlying query to be
called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public BOMItemCategoryTextByKeyFluentHelper getBOMItemCategoryTextByKey(String language, String billOfMaterialItemCategory)
BillOfMaterialsService
BOMItemCategoryText
entity using key fields.getBOMItemCategoryTextByKey
in interface BillOfMaterialsService
language
- The language key indicates
Constraints: Not nullable, Maximum length: 2
billOfMaterialItemCategory
- Categorization of the items in a BOM according to set criteria, such as whether they refer to an
object (for example, material master or document info record) or whether they are kept in stock.
Constraints: Not nullable, Maximum length: 1
BOMItemCategoryText
entity using key fields. This fluent helper allows methods which modify the
underlying query to be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public ExplodeBOMFluentHelper explodeBOM(String billOfMaterial, String billOfMaterialCategory, String billOfMaterialVariant, String billOfMaterialVersion, String engineeringChangeDocument, String material, String plant, String bOMExplosionApplication, BigDecimal requiredQuantity, Boolean bOMExplosionIsLimited, String bOMItmQtyIsScrapRelevant, String billOfMaterialItemCategory, String bOMExplosionAssembly, LocalDateTime bOMExplosionDate, BigDecimal bOMExplosionLevel, Boolean bOMExplosionIsMultilevel, String materialProvisionFltrType, String sparePartFltrType)
BillOfMaterialsService
Creates a fluent helper for the ExplodeBOM OData function import.
explodeBOM
in interface BillOfMaterialsService
billOfMaterial
- Bill of Material
Constraints: Not nullable, Maximum length: 8
Original parameter name from the Odata EDM: BillOfMaterial
billOfMaterialCategory
- BOM category
Constraints: Not nullable, Maximum length: 1
Original parameter name from the Odata EDM: BillOfMaterialCategory
billOfMaterialVariant
- Alternative BOM
Constraints: Not nullable, Maximum length: 2
Original parameter name from the Odata EDM: BillOfMaterialVariant
billOfMaterialVersion
- BOM Version
Constraints: Not nullable, Maximum length: 4
Original parameter name from the Odata EDM: BillOfMaterialVersion
engineeringChangeDocument
- Change Number
Constraints: Not nullable, Maximum length: 12
Original parameter name from the Odata EDM: EngineeringChangeDocument
material
- Material
Constraints: Not nullable, Maximum length: 40
Original parameter name from the Odata EDM: Material
plant
- Plant
Constraints: Not nullable, Maximum length: 4
Original parameter name from the Odata EDM: Plant
bOMExplosionApplication
- BOM Application
Constraints: Not nullable, Maximum length: 4
Original parameter name from the Odata EDM: BOMExplosionApplication
requiredQuantity
- Base quantity
Constraints: Not nullable, Precision: 13, Scale: 3
Original parameter name from the Odata EDM: RequiredQuantity
bOMExplosionIsLimited
- Limited Explosion
Constraints: none
Original parameter name from the Odata EDM: BOMExplosionIsLimited
bOMItmQtyIsScrapRelevant
- Exceptions
Constraints: Not nullable, Maximum length: 1
Original parameter name from the Odata EDM: BOMItmQtyIsScrapRelevant
billOfMaterialItemCategory
- Item category
Constraints: Not nullable, Maximum length: 1
Original parameter name from the Odata EDM: BillOfMaterialItemCategory
bOMExplosionAssembly
- Material
Constraints: Not nullable, Maximum length: 40
Original parameter name from the Odata EDM: BOMExplosionAssembly
bOMExplosionDate
- Valid From
Constraints: Not nullable, Precision: 0
Original parameter name from the Odata EDM: BOMExplosionDate
bOMExplosionLevel
- Explosion level
Constraints: Not nullable, Precision: 3, Scale: 0
Original parameter name from the Odata EDM: BOMExplosionLevel
bOMExplosionIsMultilevel
- Multi-lev.
Constraints: none
Original parameter name from the Odata EDM: BOMExplosionIsMultilevel
materialProvisionFltrType
- Mat. Provision Ind.
Constraints: Not nullable, Maximum length: 1
Original parameter name from the Odata EDM: MaterialProvisionFltrType
sparePartFltrType
- Spare Part Indicator
Constraints: Not nullable, Maximum length: 1
Original parameter name from the Odata EDM: SparePartFltrType
execute
method on the fluent helper object.@Nonnull public ReleaseVersionBOMFluentHelper releaseVersionBOM(String billOfMaterial, String billOfMaterialCategory, String billOfMaterialVariant, String billOfMaterialVersion, String engineeringChangeDocument, String material, String plant)
BillOfMaterialsService
Creates a fluent helper for the ReleaseVersionBOM OData function import.
releaseVersionBOM
in interface BillOfMaterialsService
billOfMaterial
- Bill of Material
Constraints: Not nullable, Maximum length: 8
Original parameter name from the Odata EDM: BillOfMaterial
billOfMaterialCategory
- BOM category
Constraints: Not nullable, Maximum length: 1
Original parameter name from the Odata EDM: BillOfMaterialCategory
billOfMaterialVariant
- Alternative BOM
Constraints: Not nullable, Maximum length: 2
Original parameter name from the Odata EDM: BillOfMaterialVariant
billOfMaterialVersion
- BOM Version
Constraints: Not nullable, Maximum length: 4
Original parameter name from the Odata EDM: BillOfMaterialVersion
engineeringChangeDocument
- Change Number
Constraints: Not nullable, Maximum length: 12
Original parameter name from the Odata EDM: EngineeringChangeDocument
material
- Material
Constraints: Not nullable, Maximum length: 40
Original parameter name from the Odata EDM: Material
plant
- Plant
Constraints: Not nullable, Maximum length: 4
Original parameter name from the Odata EDM: Plant
execute
method on the fluent helper object.Copyright © 2018 SAP SE. All rights reserved.