com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billofmaterialcomparison

Class BOMComparisonFluentHelper

java.lang.Object

com.sap.cloud.sdk.datamodel.odata.helper.FluentHelperBasic<FluentHelperT,ObjectT,ResultT>

com.sap.cloud.sdk.datamodel.odata.helper.FluentHelperFunction<BOMComparisonFluentHelper,ComparisonResult,List<ComparisonResult>>

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.billofmaterialcomparison.BOMComparisonFluentHelper

public class BOMComparisonFluentHelper
extends FluentHelperFunction<BOMComparisonFluentHelper,ComparisonResult,List<ComparisonResult>>

Fluent helper for the BOMComparison OData function import.

Constructor Summary

Constructors

Constructor and Description

BOMComparisonFluentHelper(String servicePath, 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 object that will execute the BOMComparison OData function import with the provided parameters.

Method Summary

Modifier and Type	Method and Description
protected org.apache.http.client.methods.HttpUriRequest	createRequest(URI uri) Creates a request for this function based on the given URI.
List<ComparisonResult>	execute(HttpDestinationProperties destination)
protected Class<ComparisonResult>	getEntityClass() Returns a class object of the type this fluent helper works with.
protected String	getFunctionName() The exact name of the function to be called on the OData Endpoint.
protected Map<String,Object>	getParameters() Getter for the map of parameters to be used in the function call.
protected com.google.gson.JsonElement	refineJsonResponse(com.google.gson.JsonElement jsonElement) Transform the JSON element from the response to extract a result entity.

Methods inherited from class com.sap.cloud.sdk.datamodel.odata.helper.FluentHelperFunction

executeMultiple, executeSingle, getJsonResponseObjectName

Methods inherited from class com.sap.cloud.sdk.datamodel.odata.helper.FluentHelperBasic

cachingMetadata, getHeadersForRequestAndImplicitRequests, getHeadersForRequestOnly, getParametersForRequestOnly, getServicePath, getThis, getVersionIdentifier, isCachingMetadata, withHeader, withHeaders, withoutCachingMetadata, withQueryParameter

Methods inherited from class java.lang.Object

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

Constructor Detail

BOMComparisonFluentHelper

public BOMComparisonFluentHelper(@Nonnull
                                 String servicePath,
                                 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 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.

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

servicePath - Service path to be used to call the functions against.

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

Method Detail

getEntityClass

@Nonnull
protected Class<ComparisonResult> getEntityClass()

Description copied from class: FluentHelperBasic

Returns a class object of the type this fluent helper works with.

Specified by:

getEntityClass in class FluentHelperBasic<BOMComparisonFluentHelper,ComparisonResult,List<ComparisonResult>>

Returns:

A class object of the handled type.

getFunctionName

@Nonnull
protected String getFunctionName()

Description copied from class: FluentHelperFunction

The exact name of the function to be called on the OData Endpoint.

Specified by:

getFunctionName in class FluentHelperFunction<BOMComparisonFluentHelper,ComparisonResult,List<ComparisonResult>>

Returns:

The function name on the endpoint.

refineJsonResponse

@Nullable
protected com.google.gson.JsonElement refineJsonResponse(@Nullable
                                                                   com.google.gson.JsonElement jsonElement)

Description copied from class: FluentHelperFunction

Transform the JSON element from the response to extract a result entity. By default this method returns the original object.

Overrides:

refineJsonResponse in class FluentHelperFunction<BOMComparisonFluentHelper,ComparisonResult,List<ComparisonResult>>

Parameters:

jsonElement - The optional response JSON element

Returns:

The refined JSON element

getParameters

@Nonnull
protected Map<String,Object> getParameters()

Description copied from class: FluentHelperFunction

Getter for the map of parameters to be used in the function call.

The map maps the ODataName of a parameter to the corresponding value.

Specified by:

getParameters in class FluentHelperFunction<BOMComparisonFluentHelper,ComparisonResult,List<ComparisonResult>>

Returns:

A map containing the parameter for the function call.

createRequest

@Nonnull
protected org.apache.http.client.methods.HttpUriRequest createRequest(@Nonnull
                                                                               URI uri)

Description copied from class: FluentHelperFunction

Creates a request for this function based on the given URI.

Examples for such requests are HttpGet and HttpPost.

Specified by:

createRequest in class FluentHelperFunction<BOMComparisonFluentHelper,ComparisonResult,List<ComparisonResult>>

Parameters:

uri - The URI the request should target.

Returns:

The instantiated request.

execute

@Nonnull
public List<ComparisonResult> execute(@Nonnull
                                               HttpDestinationProperties destination)
                                        throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Specified by:

execute in class FluentHelperBasic<BOMComparisonFluentHelper,ComparisonResult,List<ComparisonResult>>

Throws:

com.sap.cloud.sdk.odatav2.connectivity.ODataException