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

Class SalesOrderBOMByKeyFluentHelper

java.lang.Object

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

com.sap.cloud.sdk.datamodel.odata.helper.FluentHelperByKey<SalesOrderBOMByKeyFluentHelper,SalesOrderBOM,SalesOrderBOMSelectable>

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.orderbillofmaterial.SalesOrderBOMByKeyFluentHelper

All Implemented Interfaces:

FluentHelperCustomHttpHeader<SalesOrderBOMByKeyFluentHelper>, FluentHelperExecutable<Object>

public class SalesOrderBOMByKeyFluentHelper
extends FluentHelperByKey<SalesOrderBOMByKeyFluentHelper,SalesOrderBOM,SalesOrderBOMSelectable>

Fluent helper to fetch a single SalesOrderBOM entity using key fields. This fluent helper allows methods which modify the underlying query to be called before executing the query itself.

Constructor Summary

Constructors

Constructor and Description
SalesOrderBOMByKeyFluentHelper(String servicePath, String billOfMaterialCategory, String billOfMaterial, String billOfMaterialVariant, String engineeringChangeDocument, String material, String plant) Deprecated. Use the constructor SalesOrderBOMByKeyFluentHelper(String, String, String, String, String, String, String, String) instead.
SalesOrderBOMByKeyFluentHelper(String servicePath, String entityCollection, String billOfMaterialCategory, String billOfMaterial, String billOfMaterialVariant, String engineeringChangeDocument, String material, String plant) Creates a fluent helper object that will fetch a single SalesOrderBOM entity with the provided key field values.

Method Summary

Modifier and Type	Method and Description
protected Class<SalesOrderBOM>	getEntityClass() Returns a class object of the type this fluent helper works with.
protected Map<String,Object>	getKey() Getter for a map containing the OData name of key properties, each mapped to the value to search by.

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

execute, executeRequest, getQueryBuilder, select, toQuery, toRequest, withErrorHandler, withQueryParameter

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

and, cachingMetadata, getHeaders, getHeadersForRequestAndImplicitRequests, getHeadersForRequestOnly, getParametersForRequestOnly, getServicePath, getThis, getVersionIdentifier, isCachingMetadata, onRequestAndImplicitRequests, onRequestOnly, withHeader, withHeaders, withoutCachingMetadata

Methods inherited from class java.lang.Object

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

Constructor Detail

SalesOrderBOMByKeyFluentHelper

@Deprecated
public SalesOrderBOMByKeyFluentHelper(@Nonnull
                                                  String servicePath,
                                                  String billOfMaterialCategory,
                                                  String billOfMaterial,
                                                  String billOfMaterialVariant,
                                                  String engineeringChangeDocument,
                                                  String material,
                                                  String plant)

Deprecated. Use the constructor SalesOrderBOMByKeyFluentHelper(String, String, String, String, String, String, String, String) instead.

Creates a fluent helper object that will fetch a single SalesOrderBOM entity with the provided key field values. To perform execution, call the execute method on the fluent helper object.

Parameters:

material - Alphanumeric key uniquely identifying the material.

Constraints: Not nullable, Maximum length: 40

billOfMaterialCategory - This key defines a BOM according to the object (such as material or equipment) to which it is linked.

Constraints: Not nullable, Maximum length: 1

servicePath - Service path to be used to fetch a single SalesOrderBOM

engineeringChangeDocument - Number used to uniquely identify a change master record.

Constraints: Not nullable, Maximum length: 12

plant - Key uniquely identifying a plant.

Constraints: Not nullable, Maximum length: 4

billOfMaterial - Number used in combination with the BOM category to uniquely identify a BOM or a BOM group.

Constraints: Not nullable, Maximum length: 8

billOfMaterialVariant - Identifies one BOM in a BOM group.

Constraints: Not nullable, Maximum length: 2

SalesOrderBOMByKeyFluentHelper

public SalesOrderBOMByKeyFluentHelper(@Nonnull
                                      String servicePath,
                                      @Nonnull
                                      String entityCollection,
                                      String billOfMaterialCategory,
                                      String billOfMaterial,
                                      String billOfMaterialVariant,
                                      String engineeringChangeDocument,
                                      String material,
                                      String plant)

Creates a fluent helper object that will fetch a single SalesOrderBOM entity with the provided key field values. To perform execution, call the execute method on the fluent helper object.

Parameters:

entityCollection - Entity Collection to be used to fetch a single SalesOrderBOM

material - Alphanumeric key uniquely identifying the material.

Constraints: Not nullable, Maximum length: 40

billOfMaterialCategory - This key defines a BOM according to the object (such as material or equipment) to which it is linked.

Constraints: Not nullable, Maximum length: 1

servicePath - Service path to be used to fetch a single SalesOrderBOM

engineeringChangeDocument - Number used to uniquely identify a change master record.

Constraints: Not nullable, Maximum length: 12

plant - Key uniquely identifying a plant.

Constraints: Not nullable, Maximum length: 4

billOfMaterial - Number used in combination with the BOM category to uniquely identify a BOM or a BOM group.

Constraints: Not nullable, Maximum length: 8

billOfMaterialVariant - Identifies one BOM in a BOM group.

Constraints: Not nullable, Maximum length: 2

Method Detail

getEntityClass

@Nonnull
protected Class<SalesOrderBOM> getEntityClass()

Description copied from class: FluentHelperBasic

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

Specified by:

getEntityClass in class FluentHelperBasic<SalesOrderBOMByKeyFluentHelper,SalesOrderBOM,SalesOrderBOM>

Returns:

A class object of the handled type.

getKey

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

Description copied from class: FluentHelperByKey

Getter for a map containing the OData name of key properties, each mapped to the value to search by.

Specified by:

getKey in class FluentHelperByKey<SalesOrderBOMByKeyFluentHelper,SalesOrderBOM,SalesOrderBOMSelectable>

Returns:

A name-value mapping for the OData key properties.