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

Interface BillOfMaterialComparisonService

All Superinterfaces:

BatchService<BillOfMaterialComparisonServiceBatch>

All Known Implementing Classes:

DefaultBillOfMaterialComparisonService

public interface BillOfMaterialComparisonService
extends BatchService<BillOfMaterialComparisonServiceBatch>

This service enables you to compare two bills of material (BOMs) by comparing their BOM item attributes..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_BILLOFMATERIAL_COMPARISON_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)
Authentication Methods:	Basic, x509

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(Boolean isBOMItemQuantity, String changeNumberSecondary, Boolean isBOMItemCategory, Boolean isBOMItemDescription, Boolean isBOMItemNumber, String materialPrimary, String plantPrimary, String bOMVariantUsagePrimary, String bOMVariantPrimary, String bOMVersionPrimary, LocalDateTime bOMValidityDatePrimary, String changeNumberPrimary, String materialSecondary, String plantSecondary, String bOMVariantUsageSecondary, String bOMVariantSecondary, String bOMVersionSecondary, LocalDateTime bOMValidityDateSecondary) 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.s4hana.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 - Globally Unique Identifier

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(Boolean isBOMItemQuantity,
                                                 String changeNumberSecondary,
                                                 Boolean isBOMItemCategory,
                                                 Boolean isBOMItemDescription,
                                                 Boolean isBOMItemNumber,
                                                 String materialPrimary,
                                                 String plantPrimary,
                                                 String bOMVariantUsagePrimary,
                                                 String bOMVariantPrimary,
                                                 String bOMVersionPrimary,
                                                 LocalDateTime bOMValidityDatePrimary,
                                                 String changeNumberPrimary,
                                                 String materialSecondary,
                                                 String plantSecondary,
                                                 String bOMVariantUsageSecondary,
                                                 String bOMVariantSecondary,
                                                 String bOMVersionSecondary,
                                                 LocalDateTime bOMValidityDateSecondary)

Creates a fluent helper for the BOMComparison OData function import.

Parameters:

isBOMItemNumber - Indicator

Constraints: none

Original parameter name from the Odata EDM: IsBOMItemNumber

bOMVariantSecondary - Constraints: none

Original parameter name from the Odata EDM: BOMVariantSecondary

isBOMItemDescription - Indicator

Constraints: none

Original parameter name from the Odata EDM: IsBOMItemDescription

isBOMItemCategory - Indicator

Constraints: none

Original parameter name from the Odata EDM: IsBOMItemCategory

changeNumberPrimary - Constraints: none

Original parameter name from the Odata EDM: ChangeNumberPrimary

plantSecondary - Constraints: none

Original parameter name from the Odata EDM: PlantSecondary

changeNumberSecondary - Constraints: none

Original parameter name from the Odata EDM: ChangeNumberSecondary

bOMVariantPrimary - Constraints: none

Original parameter name from the Odata EDM: BOMVariantPrimary

bOMVersionSecondary - Constraints: none

Original parameter name from the Odata EDM: BOMVersionSecondary

isBOMItemQuantity - Indicator

Constraints: none

Original parameter name from the Odata EDM: IsBOMItemQuantity

bOMVariantUsagePrimary - Constraints: none

Original parameter name from the Odata EDM: BOMVariantUsagePrimary

materialSecondary - Constraints: none

Original parameter name from the Odata EDM: MaterialSecondary

plantPrimary - Constraints: none

Original parameter name from the Odata EDM: PlantPrimary

bOMValidityDatePrimary - Time Stamp

Constraints: Not nullable, Precision: 0

Original parameter name from the Odata EDM: BOMValidityDatePrimary

bOMVariantUsageSecondary - Constraints: none

Original parameter name from the Odata EDM: BOMVariantUsageSecondary

bOMVersionPrimary - Constraints: none

Original parameter name from the Odata EDM: BOMVersionPrimary

bOMValidityDateSecondary - Time Stamp

Constraints: Not nullable, Precision: 0

Original parameter name from the Odata EDM: BOMValidityDateSecondary

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.