@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultBillOfMaterialsService") public class DefaultBillOfMaterialsService extends Object implements BillOfMaterialsService
The service enables you to read, create, and update bills of material with and without version. The service 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 none or more items for each header. .
Reference: SAP API Business Hub
OData Service: | API_BILL_OF_MATERIAL_SRV |
API Version: | 1 |
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), Change Manufacturing Bill of Material for Production (3LO), Mass Change Manufacturing Bill of Material for Production (3LP) |
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 |
---|---|
DefaultBillOfMaterialsServiceBatch |
batch()
Instantiate a new FluentHelper instance for a single OData batch request.
|
BillOfMaterialCreateFluentHelper |
createBillOfMaterial(BillOfMaterial billOfMaterial)
Create a new
BillOfMaterial entity and save it to the S/4HANA system. |
BillOfMaterialItemCreateFluentHelper |
createBillOfMaterialItem(BillOfMaterialItem billOfMaterialItem)
Create a new
BillOfMaterialItem entity and save it to the S/4HANA system. |
ExplodeBOMFluentHelper |
explodeBOM(UUID billOfMaterialHeaderUUID,
String material,
String plant,
String billOfMaterialVariant,
String bOMExplosionApplication,
BigDecimal requiredQuantity,
String engineeringChangeDocument,
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.
|
BillOfMaterialFluentHelper |
getAllBillOfMaterial()
Fetch multiple
BillOfMaterial entities. |
BillOfMaterialItemFluentHelper |
getAllBillOfMaterialItem()
Fetch multiple
BillOfMaterialItem entities. |
BillOfMaterialUsageFluentHelper |
getAllBillOfMaterialUsage()
Fetch multiple
BillOfMaterialUsage entities. |
BillOfMaterialUsageTextFluentHelper |
getAllBillOfMaterialUsageText()
Fetch multiple
BillOfMaterialUsageText entities. |
BOMItemCategoryFluentHelper |
getAllBOMItemCategory()
Fetch multiple
BOMItemCategory entities. |
BOMItemCategoryTextFluentHelper |
getAllBOMItemCategoryText()
Fetch multiple
BOMItemCategoryText entities. |
BillOfMaterialByKeyFluentHelper |
getBillOfMaterialByKey(UUID billOfMaterialHeaderUUID)
Fetch a single
BillOfMaterial entity using key fields. |
BillOfMaterialItemByKeyFluentHelper |
getBillOfMaterialItemByKey(UUID billOfMaterialItemUUID)
Fetch a single
BillOfMaterialItem entity using key fields. |
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. |
ReleaseVersionBOMFluentHelper |
releaseVersionBOM(UUID billOfMaterialHeaderUUID,
String stlnr,
String stlty,
String stlal,
String bomVersn,
String versnst,
Boolean versnlastind)
Creates a fluent helper for the ReleaseVersionBOM OData function import.
|
BillOfMaterialUpdateFluentHelper |
updateBillOfMaterial(BillOfMaterial billOfMaterial)
Update an existing
BillOfMaterial entity and save it to the S/4HANA system. |
BillOfMaterialItemUpdateFluentHelper |
updateBillOfMaterialItem(BillOfMaterialItem billOfMaterialItem)
Update an existing
BillOfMaterialItem 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 DefaultBillOfMaterialsServiceBatch batch()
batch
in interface BatchService<BillOfMaterialsServiceBatch>
@Nonnull public BillOfMaterialFluentHelper getAllBillOfMaterial()
BillOfMaterialsService
BillOfMaterial
entities.getAllBillOfMaterial
in interface BillOfMaterialsService
BillOfMaterial
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 BillOfMaterialByKeyFluentHelper getBillOfMaterialByKey(UUID billOfMaterialHeaderUUID)
BillOfMaterialsService
BillOfMaterial
entity using key fields.getBillOfMaterialByKey
in interface BillOfMaterialsService
billOfMaterialHeaderUUID
- Global identification of a BOM header change status
Constraints: Not nullable
BillOfMaterial
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 BillOfMaterialCreateFluentHelper createBillOfMaterial(@Nonnull BillOfMaterial billOfMaterial)
BillOfMaterialsService
BillOfMaterial
entity and save it to the S/4HANA system.createBillOfMaterial
in interface BillOfMaterialsService
billOfMaterial
- BillOfMaterial
entity object that will be created in the S/4HANA system.BillOfMaterial
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public BillOfMaterialUpdateFluentHelper updateBillOfMaterial(@Nonnull BillOfMaterial billOfMaterial)
BillOfMaterialsService
BillOfMaterial
entity and save it to the S/4HANA system.updateBillOfMaterial
in interface BillOfMaterialsService
billOfMaterial
- BillOfMaterial
entity object that will be updated in the S/4HANA system.BillOfMaterial
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public BillOfMaterialItemFluentHelper getAllBillOfMaterialItem()
BillOfMaterialsService
BillOfMaterialItem
entities.getAllBillOfMaterialItem
in interface BillOfMaterialsService
BillOfMaterialItem
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 BillOfMaterialItemByKeyFluentHelper getBillOfMaterialItemByKey(UUID billOfMaterialItemUUID)
BillOfMaterialsService
BillOfMaterialItem
entity using key fields.getBillOfMaterialItemByKey
in interface BillOfMaterialsService
billOfMaterialItemUUID
- Global identification of an item's change status
Constraints: Not nullable
BillOfMaterialItem
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 BillOfMaterialItemCreateFluentHelper createBillOfMaterialItem(@Nonnull BillOfMaterialItem billOfMaterialItem)
BillOfMaterialsService
BillOfMaterialItem
entity and save it to the S/4HANA system.createBillOfMaterialItem
in interface BillOfMaterialsService
billOfMaterialItem
- BillOfMaterialItem
entity object that will be created in the S/4HANA system.BillOfMaterialItem
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public BillOfMaterialItemUpdateFluentHelper updateBillOfMaterialItem(@Nonnull BillOfMaterialItem billOfMaterialItem)
BillOfMaterialsService
BillOfMaterialItem
entity and save it to the S/4HANA system.updateBillOfMaterialItem
in interface BillOfMaterialsService
billOfMaterialItem
- BillOfMaterialItem
entity object that will be updated in the S/4HANA system.BillOfMaterialItem
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 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(@Nonnull UUID billOfMaterialHeaderUUID, @Nullable String material, @Nullable String plant, @Nullable String billOfMaterialVariant, @Nullable String bOMExplosionApplication, @Nullable BigDecimal requiredQuantity, @Nullable String engineeringChangeDocument, @Nullable Boolean bOMExplosionIsLimited, @Nullable String bOMItmQtyIsScrapRelevant, @Nullable String billOfMaterialItemCategory, @Nullable String bOMExplosionAssembly, @Nullable LocalDateTime bOMExplosionDate, @Nullable BigDecimal bOMExplosionLevel, @Nullable Boolean bOMExplosionIsMultilevel, @Nullable String materialProvisionFltrType, @Nullable String sparePartFltrType)
BillOfMaterialsService
Creates a fluent helper for the ExplodeBOM OData function import.
explodeBOM
in interface BillOfMaterialsService
billOfMaterialHeaderUUID
- ID hdr chge status
Constraints: none
Original parameter name from the Odata EDM: BillOfMaterialHeaderUUID
material
- Material
Constraints: Nullable, Maximum length: 40
Original parameter name from the Odata EDM: Material
plant
- Plant
Constraints: Nullable, Maximum length: 4
Original parameter name from the Odata EDM: Plant
billOfMaterialVariant
- Alternative BOM
Constraints: Nullable, Maximum length: 2
Original parameter name from the Odata EDM: BillOfMaterialVariant
bOMExplosionApplication
- BOM Application
Constraints: Nullable, Maximum length: 4
Original parameter name from the Odata EDM: BOMExplosionApplication
requiredQuantity
- Base quantity
Constraints: Nullable, Precision: 13, Scale: 3
Original parameter name from the Odata EDM: RequiredQuantity
engineeringChangeDocument
- Change Number
Constraints: Nullable, Maximum length: 12
Original parameter name from the Odata EDM: EngineeringChangeDocument
bOMExplosionIsLimited
- Limited Explosion
Constraints: Nullable
Original parameter name from the Odata EDM: BOMExplosionIsLimited
bOMItmQtyIsScrapRelevant
- Exceptions
Constraints: Nullable, Maximum length: 1
Original parameter name from the Odata EDM: BOMItmQtyIsScrapRelevant
billOfMaterialItemCategory
- Item category
Constraints: Nullable, Maximum length: 1
Original parameter name from the Odata EDM: BillOfMaterialItemCategory
bOMExplosionAssembly
- Material
Constraints: Nullable, Maximum length: 40
Original parameter name from the Odata EDM: BOMExplosionAssembly
bOMExplosionDate
- Valid From
Constraints: Nullable, Precision: 0
Original parameter name from the Odata EDM: BOMExplosionDate
bOMExplosionLevel
- Explosion level
Constraints: Nullable, Precision: 3, Scale: 0
Original parameter name from the Odata EDM: BOMExplosionLevel
bOMExplosionIsMultilevel
- Multi-lev.
Constraints: Nullable
Original parameter name from the Odata EDM: BOMExplosionIsMultilevel
materialProvisionFltrType
- Mat. Provision Ind.
Constraints: Nullable, Maximum length: 1
Original parameter name from the Odata EDM: MaterialProvisionFltrType
sparePartFltrType
- Spare Part Indicator
Constraints: Nullable, Maximum length: 1
Original parameter name from the Odata EDM: SparePartFltrType
execute
method on the fluent helper object.@Nonnull public ReleaseVersionBOMFluentHelper releaseVersionBOM(@Nonnull UUID billOfMaterialHeaderUUID, @Nullable String stlnr, @Nullable String stlty, @Nullable String stlal, @Nullable String bomVersn, @Nullable String versnst, @Nullable Boolean versnlastind)
BillOfMaterialsService
Creates a fluent helper for the ReleaseVersionBOM OData function import.
releaseVersionBOM
in interface BillOfMaterialsService
billOfMaterialHeaderUUID
- ID hdr chge status
Constraints: none
Original parameter name from the Odata EDM: BillOfMaterialHeaderUUID
stlnr
- Bill of Material
Constraints: Nullable, Maximum length: 8
Original parameter name from the Odata EDM: Stlnr
stlty
- BOM category
Constraints: Nullable, Maximum length: 1
Original parameter name from the Odata EDM: Stlty
stlal
- Alternative BOM
Constraints: Nullable, Maximum length: 2
Original parameter name from the Odata EDM: Stlal
bomVersn
- BOM Version
Constraints: Nullable, Maximum length: 4
Original parameter name from the Odata EDM: BomVersn
versnst
- BOM Version Status
Constraints: Nullable, Maximum length: 2
Original parameter name from the Odata EDM: Versnst
versnlastind
- Latest Version
Constraints: Nullable
Original parameter name from the Odata EDM: Versnlastind
execute
method on the fluent helper object.Copyright © 2021 SAP SE. All rights reserved.