com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odata.services

Interface BillOfMaterialComparisonService

All Superinterfaces:

BatchService<BillOfMaterialComparisonServiceBatch>

All Known Implementing Classes:

DefaultBillOfMaterialComparisonService

public interface BillOfMaterialComparisonService
extends BatchService<BillOfMaterialComparisonServiceBatch>

The service enables you to compare two bills of material (primary and secondary BOM) by comparing their BOM item attributes and gets the comparison result. The comparison result shows all the BOM item attributes that are in the primary BOM and the secondary BOM. .

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	OP_API_BILLOFMATERIAL_COMPARISON_SRV
API Version:	1
Minimum ERP Version:	2020
Authentication Methods:	Basic, x509
Business Object:	Bill Of Material

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SERVICE_PATH If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

Method Summary

Modifier and Type	Method and Description
BOMComparisonFluentHelper	bOMComparison(LocalDateTime bOMValidityDateSecondary, String bOMVersionSecondary, String bOMVariantSecondary, String bOMVariantUsageSecondary, String plantSecondary, String materialSecondary, String changeNumberPrimary, LocalDateTime bOMValidityDatePrimary, String bOMVersionPrimary, String bOMVariantPrimary, String bOMVariantUsagePrimary, String plantPrimary, String materialPrimary, Boolean isBOMItemNumber, Boolean isBOMItemDescription, Boolean isBOMItemCategory, String changeNumberSecondary, Boolean isBOMItemQuantity) Creates a fluent helper for the BOMComparison OData function import.
ComparisonResultFluentHelper	getAllComparisonResult() Fetch multiple ComparisonResult entities.
ComparisonResultByKeyFluentHelper	getComparisonResultByKey(byte[] bOMComparisonUUID) Fetch a single ComparisonResult entity using key fields.
BillOfMaterialComparisonService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from interface com.sap.cloud.sdk.datamodel.odata.helper.batch.BatchService

batch

Field Detail

DEFAULT_SERVICE_PATH

static final String DEFAULT_SERVICE_PATH

If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

See Also:

Constant Field Values

Method Detail

withServicePath

@Nonnull
BillOfMaterialComparisonService withServicePath(@Nonnull
                                                         String servicePath)

Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

getAllComparisonResult

@Nonnull
ComparisonResultFluentHelper getAllComparisonResult()

Fetch multiple ComparisonResult entities.

Returns:

A fluent helper to fetch multiple ComparisonResult 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.

getComparisonResultByKey

@Nonnull
ComparisonResultByKeyFluentHelper getComparisonResultByKey(byte[] bOMComparisonUUID)

Fetch a single ComparisonResult entity using key fields.

Parameters:

bOMComparisonUUID - GUID

Constraints: Not nullable

Returns:

A fluent helper to fetch a single ComparisonResult 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.

bOMComparison

@Nonnull
BOMComparisonFluentHelper bOMComparison(LocalDateTime bOMValidityDateSecondary,
                                                 String bOMVersionSecondary,
                                                 String bOMVariantSecondary,
                                                 String bOMVariantUsageSecondary,
                                                 String plantSecondary,
                                                 String materialSecondary,
                                                 String changeNumberPrimary,
                                                 LocalDateTime bOMValidityDatePrimary,
                                                 String bOMVersionPrimary,
                                                 String bOMVariantPrimary,
                                                 String bOMVariantUsagePrimary,
                                                 String plantPrimary,
                                                 String materialPrimary,
                                                 Boolean isBOMItemNumber,
                                                 Boolean isBOMItemDescription,
                                                 Boolean isBOMItemCategory,
                                                 String changeNumberSecondary,
                                                 Boolean isBOMItemQuantity)

Creates a fluent helper for the BOMComparison OData function import.

Parameters:

isBOMItemNumber - Constraints: none

Original parameter name from the Odata EDM: IsBOMItemNumber

bOMVariantSecondary - Constraints: none

Original parameter name from the Odata EDM: BOMVariantSecondary

isBOMItemDescription - Constraints: none

Original parameter name from the Odata EDM: IsBOMItemDescription

changeNumberPrimary - Constraints: none

Original parameter name from the Odata EDM: ChangeNumberPrimary

isBOMItemCategory - Constraints: none

Original parameter name from the Odata EDM: IsBOMItemCategory

plantSecondary - Constraints: none

Original parameter name from the Odata EDM: PlantSecondary

changeNumberSecondary - Constraints: none

Original parameter name from the Odata EDM: ChangeNumberSecondary

bOMVersionSecondary - Constraints: none

Original parameter name from the Odata EDM: BOMVersionSecondary

bOMVariantPrimary - Constraints: none

Original parameter name from the Odata EDM: BOMVariantPrimary

isBOMItemQuantity - Constraints: none

Original parameter name from the Odata EDM: IsBOMItemQuantity

materialSecondary - Constraints: none

Original parameter name from the Odata EDM: MaterialSecondary

bOMVariantUsagePrimary - Constraints: none

Original parameter name from the Odata EDM: BOMVariantUsagePrimary

plantPrimary - Constraints: none

Original parameter name from the Odata EDM: PlantPrimary

bOMValidityDatePrimary - Constraints: Not nullable, Precision: 0

Original parameter name from the Odata EDM: BOMValidityDatePrimary

bOMVariantUsageSecondary - Constraints: none

Original parameter name from the Odata EDM: BOMVariantUsageSecondary

bOMValidityDateSecondary - Constraints: Not nullable, Precision: 0

Original parameter name from the Odata EDM: BOMValidityDateSecondary

bOMVersionPrimary - Constraints: none

Original parameter name from the Odata EDM: BOMVersionPrimary

materialPrimary - Constraints: none

Original parameter name from the Odata EDM: MaterialPrimary

Returns:

A fluent helper object that will execute the BOMComparison OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.