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

Class DefaultBillOfMaterialComparisonService

java.lang.Object

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

All Implemented Interfaces:

BatchService<BillOfMaterialComparisonServiceBatch>, BillOfMaterialComparisonService

@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultBillOfMaterialComparisonService")
public class DefaultBillOfMaterialComparisonService
extends Object
implements BillOfMaterialComparisonService

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), Change Manufacturing Bill of Material for Production (3LO), Mass Change Manufacturing Bill of Material for Production (3LP)
Authentication Methods:	Basic, x509

Field Summary

Fields inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.BillOfMaterialComparisonService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultBillOfMaterialComparisonService() Creates a service using BillOfMaterialComparisonService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
DefaultBillOfMaterialComparisonServiceBatch	batch() Instantiate a new FluentHelper instance for a single OData batch request.
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.
DefaultBillOfMaterialComparisonService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultBillOfMaterialComparisonService

public DefaultBillOfMaterialComparisonService()

Creates a service using BillOfMaterialComparisonService.DEFAULT_SERVICE_PATH to send the requests.

Method Detail

withServicePath

@Nonnull
public DefaultBillOfMaterialComparisonService withServicePath(@Nonnull
                                                                       String servicePath)

Description copied from interface: BillOfMaterialComparisonService

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

Specified by:

withServicePath in interface BillOfMaterialComparisonService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultBillOfMaterialComparisonServiceBatch batch()

Instantiate a new FluentHelper instance for a single OData batch request.

Specified by:

batch in interface BatchService<BillOfMaterialComparisonServiceBatch>

Returns:

A new instance of an OData batch request associated with the service object.

getAllComparisonResult

@Nonnull
public ComparisonResultFluentHelper getAllComparisonResult()

Description copied from interface: BillOfMaterialComparisonService

Fetch multiple ComparisonResult entities.

Specified by:

getAllComparisonResult in interface BillOfMaterialComparisonService

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
public ComparisonResultByKeyFluentHelper getComparisonResultByKey(byte[] bOMComparisonUUID)

Description copied from interface: BillOfMaterialComparisonService

Fetch a single ComparisonResult entity using key fields.

Specified by:

getComparisonResultByKey in interface BillOfMaterialComparisonService

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
public 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)

Description copied from interface: BillOfMaterialComparisonService

Creates a fluent helper for the BOMComparison OData function import.

Specified by:

bOMComparison in interface BillOfMaterialComparisonService

Parameters:

bOMValidityDateSecondary - Time Stamp

Constraints: Not nullable, Precision: 0

Original parameter name from the Odata EDM: BOMValidityDateSecondary

bOMVersionSecondary - Constraints: none

Original parameter name from the Odata EDM: BOMVersionSecondary

bOMVariantSecondary - Constraints: none

Original parameter name from the Odata EDM: BOMVariantSecondary

bOMVariantUsageSecondary - Constraints: none

Original parameter name from the Odata EDM: BOMVariantUsageSecondary

plantSecondary - Constraints: none

Original parameter name from the Odata EDM: PlantSecondary

materialSecondary - Constraints: none

Original parameter name from the Odata EDM: MaterialSecondary

changeNumberPrimary - Constraints: none

Original parameter name from the Odata EDM: ChangeNumberPrimary

bOMValidityDatePrimary - Time Stamp

Constraints: Not nullable, Precision: 0

Original parameter name from the Odata EDM: BOMValidityDatePrimary

bOMVersionPrimary - Constraints: none

Original parameter name from the Odata EDM: BOMVersionPrimary

bOMVariantPrimary - Constraints: none

Original parameter name from the Odata EDM: BOMVariantPrimary

bOMVariantUsagePrimary - Constraints: none

Original parameter name from the Odata EDM: BOMVariantUsagePrimary

plantPrimary - Constraints: none

Original parameter name from the Odata EDM: PlantPrimary

materialPrimary - Constraints: none

Original parameter name from the Odata EDM: MaterialPrimary

isBOMItemNumber - Indicator

Constraints: none

Original parameter name from the Odata EDM: IsBOMItemNumber

isBOMItemDescription - Indicator

Constraints: none

Original parameter name from the Odata EDM: IsBOMItemDescription

isBOMItemCategory - Indicator

Constraints: none

Original parameter name from the Odata EDM: IsBOMItemCategory

changeNumberSecondary - Constraints: none

Original parameter name from the Odata EDM: ChangeNumberSecondary

isBOMItemQuantity - Indicator

Constraints: none

Original parameter name from the Odata EDM: IsBOMItemQuantity

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.