com.sap.cloud.sdk.s4hana.datamodel.odata.services.BillOfMaterialComparisonService Maven / Gradle / Ivy
/*
* Copyright (c) 2019 SAP SE or an SAP affiliate company. All rights reserved.
*/
package com.sap.cloud.sdk.s4hana.datamodel.odata.services;
import java.time.LocalDateTime;
import javax.annotation.Nonnull;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billofmaterialcomparison.BOMComparisonFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billofmaterialcomparison.ComparisonResultByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billofmaterialcomparison.ComparisonResultFluentHelper;
/**
*
* This service enables you to compare two Bills of Material (BOMs) by comparing their BOM item attributes.
*
*
*
* 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 Change Master Management
* (1R3)
*
*
*
*/
public interface BillOfMaterialComparisonService
{
/**
* If no other path was provided via the {@link #withServicePath(String)} method, this is the default service path
* used to access the endpoint.
*
*/
String DEFAULT_SERVICE_PATH = "/sap/opu/odata/sap/API_BILLOFMATERIAL_COMPARISON_SRV";
/**
* Overrides the default service path and returns a new service instance with the specified service path. Also
* adjusts the respective entity URLs.
*
* @param servicePath
* Service path that will override the default.
* @return A new service instance with the specified service path.
*/
@Nonnull
BillOfMaterialComparisonService withServicePath( @Nonnull final String servicePath );
/**
* Fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billofmaterialcomparison.ComparisonResult
* ComparisonResult} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billofmaterialcomparison.ComparisonResult
* 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billofmaterialcomparison.ComparisonResultFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
ComparisonResultFluentHelper getAllComparisonResult();
/**
* Fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billofmaterialcomparison.ComparisonResult
* ComparisonResult} entity using key fields.
*
* @param bOMComparisonUUID
* Globally Unique Identifier
*
* Constraints: Not nullable
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billofmaterialcomparison.ComparisonResult
* 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
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billofmaterialcomparison.ComparisonResultByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
ComparisonResultByKeyFluentHelper getComparisonResultByKey( final byte[] bOMComparisonUUID );
/**
*
* Creates a fluent helper for the BOMComparison OData function import.
*
*
* @param isBOMItemNumber
* Indicator
*
*
*
* Constraints: none
*
*
* Original parameter name from the Odata EDM: IsBOMItemNumber
*
* @param bOMVariantSecondary
* Constraints: none
*
* Original parameter name from the Odata EDM: BOMVariantSecondary
*
* @param isBOMItemDescription
* Indicator
*
*
*
* Constraints: none
*
*
* Original parameter name from the Odata EDM: IsBOMItemDescription
*
* @param isBOMItemCategory
* Indicator
*
*
*
* Constraints: none
*
*
* Original parameter name from the Odata EDM: IsBOMItemCategory
*
* @param changeNumberPrimary
* Constraints: none
*
* Original parameter name from the Odata EDM: ChangeNumberPrimary
*
* @param plantSecondary
* Constraints: none
*
* Original parameter name from the Odata EDM: PlantSecondary
*
* @param changeNumberSecondary
* Constraints: none
*
* Original parameter name from the Odata EDM: ChangeNumberSecondary
*
* @param bOMVariantPrimary
* Constraints: none
*
* Original parameter name from the Odata EDM: BOMVariantPrimary
*
* @param bOMVersionSecondary
* Constraints: none
*
* Original parameter name from the Odata EDM: BOMVersionSecondary
*
* @param isBOMItemQuantity
* Indicator
*
*
*
* Constraints: none
*
*
* Original parameter name from the Odata EDM: IsBOMItemQuantity
*
* @param bOMVariantUsagePrimary
* Constraints: none
*
* Original parameter name from the Odata EDM: BOMVariantUsagePrimary
*
* @param materialSecondary
* Constraints: none
*
* Original parameter name from the Odata EDM: MaterialSecondary
*
* @param plantPrimary
* Constraints: none
*
* Original parameter name from the Odata EDM: PlantPrimary
*
* @param bOMValidityDatePrimary
* Time Stamp
*
*
*
* Constraints: Not nullable, Precision: 0
*
*
* Original parameter name from the Odata EDM: BOMValidityDatePrimary
*
* @param bOMVariantUsageSecondary
* Constraints: none
*
* Original parameter name from the Odata EDM: BOMVariantUsageSecondary
*
* @param bOMVersionPrimary
* Constraints: none
*
* Original parameter name from the Odata EDM: BOMVersionPrimary
*
* @param bOMValidityDateSecondary
* Time Stamp
*
*
*
* Constraints: Not nullable, Precision: 0
*
*
* Original parameter name from the Odata EDM: BOMValidityDateSecondary
*
* @param materialPrimary
* Constraints: none
*
* Original parameter name from the Odata EDM: MaterialPrimary
*
* @return A fluent helper object that will execute the BOMComparison OData function import with the provided
* parameters. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billofmaterialcomparison.BOMComparisonFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
BOMComparisonFluentHelper bOMComparison(
final Boolean isBOMItemQuantity,
final String changeNumberSecondary,
final Boolean isBOMItemCategory,
final Boolean isBOMItemDescription,
final Boolean isBOMItemNumber,
final String materialPrimary,
final String plantPrimary,
final String bOMVariantUsagePrimary,
final String bOMVariantPrimary,
final String bOMVersionPrimary,
final LocalDateTime bOMValidityDatePrimary,
final String changeNumberPrimary,
final String materialSecondary,
final String plantSecondary,
final String bOMVariantUsageSecondary,
final String bOMVariantSecondary,
final String bOMVersionSecondary,
final LocalDateTime bOMValidityDateSecondary );
}