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

Interface ProductMasterDataIncludingClassificationService

All Superinterfaces:

BatchService<ProductMasterDataIncludingClassificationServiceBatch>

All Known Implementing Classes:

DefaultProductMasterDataIncludingClassificationService

public interface ProductMasterDataIncludingClassificationService
extends BatchService<ProductMasterDataIncludingClassificationServiceBatch>

Product master is a reusable set of data describing a product or service. Using the API you can read product master data, class assignment and characteristic valuation.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_CLFN_PRODUCT_SRV
API Version:	1
Communication Scenario:	Product Classification Integration (SAP_COM_0309)
Authentication Methods:	Basic, x509
Business Object:	Product

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
ClfnClassForKeyDateFluentHelper	getAllClfnClassForKeyDate() Fetch multiple ClfnClassForKeyDate entities.
ClfnProductFluentHelper	getAllClfnProduct() Fetch multiple ClfnProduct entities.
ProductCharcFluentHelper	getAllProductCharc() Fetch multiple ProductCharc entities.
ProductCharcValueFluentHelper	getAllProductCharcValue() Fetch multiple ProductCharcValue entities.
ProductClassFluentHelper	getAllProductClass() Fetch multiple ProductClass entities.
ProductClassCharcFluentHelper	getAllProductClassCharc() Fetch multiple ProductClassCharc entities.
ProductDescriptionFluentHelper	getAllProductDescription() Fetch multiple ProductDescription entities.
ProductPlantFluentHelper	getAllProductPlant() Fetch multiple ProductPlant entities.
ProductPlantProcurementFluentHelper	getAllProductPlantProcurement() Fetch multiple ProductPlantProcurement entities.
ProductSalesDeliveryFluentHelper	getAllProductSalesDelivery() Fetch multiple ProductSalesDelivery entities.
ProductSalesTaxFluentHelper	getAllProductSalesTax() Fetch multiple ProductSalesTax entities.
ProductStorageLocationFluentHelper	getAllProductStorageLocation() Fetch multiple ProductStorageLocation entities.
ProductSupplyPlanningFluentHelper	getAllProductSupplyPlanning() Fetch multiple ProductSupplyPlanning entities.
ProductWorkSchedulingFluentHelper	getAllProductWorkScheduling() Fetch multiple ProductWorkScheduling entities.
ClfnClassForKeyDateByKeyFluentHelper	getClfnClassForKeyDateByKey(String classInternalID) Fetch a single ClfnClassForKeyDate entity using key fields.
ClfnProductByKeyFluentHelper	getClfnProductByKey(String product) Fetch a single ClfnProduct entity using key fields.
ProductCharcByKeyFluentHelper	getProductCharcByKey(String product, String charcInternalID, String classType) Fetch a single ProductCharc entity using key fields.
ProductCharcValueByKeyFluentHelper	getProductCharcValueByKey(String product, String classType, String charcInternalID, String charcValuePositionNumber) Fetch a single ProductCharcValue entity using key fields.
ProductClassByKeyFluentHelper	getProductClassByKey(String product, String classInternalID) Fetch a single ProductClass entity using key fields.
ProductClassCharcByKeyFluentHelper	getProductClassCharcByKey(String product, String classInternalID, String charcInternalID) Fetch a single ProductClassCharc entity using key fields.
ProductDescriptionByKeyFluentHelper	getProductDescriptionByKey(String product, String language) Fetch a single ProductDescription entity using key fields.
ProductPlantByKeyFluentHelper	getProductPlantByKey(String product, String plant) Fetch a single ProductPlant entity using key fields.
ProductPlantProcurementByKeyFluentHelper	getProductPlantProcurementByKey(String product, String plant) Fetch a single ProductPlantProcurement entity using key fields.
ProductSalesDeliveryByKeyFluentHelper	getProductSalesDeliveryByKey(String product, String productSalesOrg, String productDistributionChnl) Fetch a single ProductSalesDelivery entity using key fields.
ProductSalesTaxByKeyFluentHelper	getProductSalesTaxByKey(String product, String country, String taxCategory, String taxClassification) Fetch a single ProductSalesTax entity using key fields.
ProductStorageLocationByKeyFluentHelper	getProductStorageLocationByKey(String product, String plant, String storageLocation) Fetch a single ProductStorageLocation entity using key fields.
ProductSupplyPlanningByKeyFluentHelper	getProductSupplyPlanningByKey(String product, String plant) Fetch a single ProductSupplyPlanning entity using key fields.
ProductWorkSchedulingByKeyFluentHelper	getProductWorkSchedulingByKey(String product, String plant) Fetch a single ProductWorkScheduling entity using key fields.
ProductMasterDataIncludingClassificationService	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.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
ProductMasterDataIncludingClassificationService 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.

getAllProductPlantProcurement

@Nonnull
ProductPlantProcurementFluentHelper getAllProductPlantProcurement()

Fetch multiple ProductPlantProcurement entities.

Returns:

A fluent helper to fetch multiple ProductPlantProcurement 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.

getProductPlantProcurementByKey

@Nonnull
ProductPlantProcurementByKeyFluentHelper getProductPlantProcurementByKey(String product,
                                                                                  String plant)

Fetch a single ProductPlantProcurement entity using key fields.

Parameters:

product - Alphanumeric key uniquely identifying the material.

Constraints: Not nullable, Maximum length: 40

plant - Key uniquely identifying a plant.

Constraints: Not nullable, Maximum length: 4

Returns:

A fluent helper to fetch a single ProductPlantProcurement 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.

getAllProductStorageLocation

@Nonnull
ProductStorageLocationFluentHelper getAllProductStorageLocation()

Fetch multiple ProductStorageLocation entities.

Returns:

A fluent helper to fetch multiple ProductStorageLocation 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.

getProductStorageLocationByKey

@Nonnull
ProductStorageLocationByKeyFluentHelper getProductStorageLocationByKey(String product,
                                                                                String plant,
                                                                                String storageLocation)

Fetch a single ProductStorageLocation entity using key fields.

Parameters:

product - Alphanumeric key uniquely identifying the material.

Constraints: Not nullable, Maximum length: 40

plant - Key uniquely identifying a plant.

Constraints: Not nullable, Maximum length: 4

storageLocation - Number of the storage location in which the material is stored. A plant may contain one or more storage locations.

Constraints: Not nullable, Maximum length: 4

Returns:

A fluent helper to fetch a single ProductStorageLocation 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.

getAllProductSupplyPlanning

@Nonnull
ProductSupplyPlanningFluentHelper getAllProductSupplyPlanning()

Fetch multiple ProductSupplyPlanning entities.

Returns:

A fluent helper to fetch multiple ProductSupplyPlanning 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.

getProductSupplyPlanningByKey

@Nonnull
ProductSupplyPlanningByKeyFluentHelper getProductSupplyPlanningByKey(String product,
                                                                              String plant)

Fetch a single ProductSupplyPlanning entity using key fields.

Parameters:

product - Alphanumeric key uniquely identifying the material.

Constraints: Not nullable, Maximum length: 40

plant - Key uniquely identifying a plant.

Constraints: Not nullable, Maximum length: 4

Returns:

A fluent helper to fetch a single ProductSupplyPlanning 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.

getAllClfnProduct

@Nonnull
ClfnProductFluentHelper getAllClfnProduct()

Fetch multiple ClfnProduct entities.

Returns:

A fluent helper to fetch multiple ClfnProduct 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.

getClfnProductByKey

@Nonnull
ClfnProductByKeyFluentHelper getClfnProductByKey(String product)

Fetch a single ClfnProduct entity using key fields.

Parameters:

product - Alphanumeric key uniquely identifying the product.

Constraints: Not nullable, Maximum length: 40

Returns:

A fluent helper to fetch a single ClfnProduct 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.

getAllClfnClassForKeyDate

@Nonnull
ClfnClassForKeyDateFluentHelper getAllClfnClassForKeyDate()

Fetch multiple ClfnClassForKeyDate entities.

Returns:

A fluent helper to fetch multiple ClfnClassForKeyDate 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.

getClfnClassForKeyDateByKey

@Nonnull
ClfnClassForKeyDateByKeyFluentHelper getClfnClassForKeyDateByKey(String classInternalID)

Fetch a single ClfnClassForKeyDate entity using key fields.

Parameters:

classInternalID - Internal Class Number

Constraints: Not nullable, Maximum length: 10

Returns:

A fluent helper to fetch a single ClfnClassForKeyDate 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.

getAllProductDescription

@Nonnull
ProductDescriptionFluentHelper getAllProductDescription()

Fetch multiple ProductDescription entities.

Returns:

A fluent helper to fetch multiple ProductDescription 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.

getProductDescriptionByKey

@Nonnull
ProductDescriptionByKeyFluentHelper getProductDescriptionByKey(String product,
                                                                        String language)

Fetch a single ProductDescription entity using key fields.

Parameters:

product - Alphanumeric key uniquely identifying the product.

Constraints: Not nullable, Maximum length: 40

language - The language key indicates

Constraints: Not nullable, Maximum length: 2

Returns:

A fluent helper to fetch a single ProductDescription 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.

getAllProductPlant

@Nonnull
ProductPlantFluentHelper getAllProductPlant()

Fetch multiple ProductPlant entities.

Returns:

A fluent helper to fetch multiple ProductPlant 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.

getProductPlantByKey

@Nonnull
ProductPlantByKeyFluentHelper getProductPlantByKey(String product,
                                                            String plant)

Fetch a single ProductPlant entity using key fields.

Parameters:

product - Alphanumeric key uniquely identifying the material.

Constraints: Not nullable, Maximum length: 40

plant - Key uniquely identifying a plant.

Constraints: Not nullable, Maximum length: 4

Returns:

A fluent helper to fetch a single ProductPlant 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.

getAllProductSalesDelivery

@Nonnull
ProductSalesDeliveryFluentHelper getAllProductSalesDelivery()

Fetch multiple ProductSalesDelivery entities.

Returns:

A fluent helper to fetch multiple ProductSalesDelivery 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.

getProductSalesDeliveryByKey

@Nonnull
ProductSalesDeliveryByKeyFluentHelper getProductSalesDeliveryByKey(String product,
                                                                            String productSalesOrg,
                                                                            String productDistributionChnl)

Fetch a single ProductSalesDelivery entity using key fields.

Parameters:

product - Alphanumeric key uniquely identifying the product.

Constraints: Not nullable, Maximum length: 40

productDistributionChnl - The way in which products or services reach the customer. Typical examples of distribution channels are wholesale, retail, or direct sales.

Constraints: Not nullable, Maximum length: 2

productSalesOrg - An organizational unit responsible for the sale of certain products or services. The responsibility of a sales organization may include legal liability for products and customer claims.

Constraints: Not nullable, Maximum length: 4

Returns:

A fluent helper to fetch a single ProductSalesDelivery 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.

getAllProductSalesTax

@Nonnull
ProductSalesTaxFluentHelper getAllProductSalesTax()

Fetch multiple ProductSalesTax entities.

Returns:

A fluent helper to fetch multiple ProductSalesTax 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.

getProductSalesTaxByKey

@Nonnull
ProductSalesTaxByKeyFluentHelper getProductSalesTaxByKey(String product,
                                                                  String country,
                                                                  String taxCategory,
                                                                  String taxClassification)

Fetch a single ProductSalesTax entity using key fields.

Parameters:

country - Identifies the country in which the delivery originates.

Constraints: Not nullable, Maximum length: 3

product - Alphanumeric key uniquely identifying the product.

Constraints: Not nullable, Maximum length: 40

taxClassification -

taxCategory - Identifies the condition that the system uses to automatically determine country-specific taxes during pricing.

Constraints: Not nullable, Maximum length: 4

Returns:

A fluent helper to fetch a single ProductSalesTax 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.

getAllProductWorkScheduling

@Nonnull
ProductWorkSchedulingFluentHelper getAllProductWorkScheduling()

Fetch multiple ProductWorkScheduling entities.

Returns:

A fluent helper to fetch multiple ProductWorkScheduling 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.

getProductWorkSchedulingByKey

@Nonnull
ProductWorkSchedulingByKeyFluentHelper getProductWorkSchedulingByKey(String product,
                                                                              String plant)

Fetch a single ProductWorkScheduling entity using key fields.

Parameters:

product - Alphanumeric key uniquely identifying the product.

Constraints: Not nullable, Maximum length: 40

plant - Key uniquely identifying a plant.

Constraints: Not nullable, Maximum length: 4

Returns:

A fluent helper to fetch a single ProductWorkScheduling 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.

getAllProductCharc

@Nonnull
ProductCharcFluentHelper getAllProductCharc()

Fetch multiple ProductCharc entities.

Returns:

A fluent helper to fetch multiple ProductCharc 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.

getProductCharcByKey

@Nonnull
ProductCharcByKeyFluentHelper getProductCharcByKey(String product,
                                                            String charcInternalID,
                                                            String classType)

Fetch a single ProductCharc entity using key fields.

Parameters:

product - Key of Object to be Classified

Constraints: Not nullable, Maximum length: 90

charcInternalID - Characteristic Internal ID

Constraints: Not nullable, Maximum length: 10

classType - Uniquely identifies the class type

Constraints: Not nullable, Maximum length: 3

Returns:

A fluent helper to fetch a single ProductCharc 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.

getAllProductCharcValue

@Nonnull
ProductCharcValueFluentHelper getAllProductCharcValue()

Fetch multiple ProductCharcValue entities.

Returns:

A fluent helper to fetch multiple ProductCharcValue 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.

getProductCharcValueByKey

@Nonnull
ProductCharcValueByKeyFluentHelper getProductCharcValueByKey(String product,
                                                                      String classType,
                                                                      String charcInternalID,
                                                                      String charcValuePositionNumber)

Fetch a single ProductCharcValue entity using key fields.

Parameters:

charcValuePositionNumber - Characteristic value counter

Constraints: Not nullable, Maximum length: 3

product - Key of Object to be Classified

Constraints: Not nullable, Maximum length: 90

charcInternalID - Characteristic Internal ID

Constraints: Not nullable, Maximum length: 10

classType - Uniquely identifies the class type

Constraints: Not nullable, Maximum length: 3

Returns:

A fluent helper to fetch a single ProductCharcValue 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.

getAllProductClass

@Nonnull
ProductClassFluentHelper getAllProductClass()

Fetch multiple ProductClass entities.

Returns:

A fluent helper to fetch multiple ProductClass 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.

getProductClassByKey

@Nonnull
ProductClassByKeyFluentHelper getProductClassByKey(String product,
                                                            String classInternalID)

Fetch a single ProductClass entity using key fields.

Parameters:

product - Key of Object to be Classified

Constraints: Not nullable, Maximum length: 90

classInternalID - Internal Class Number

Constraints: Not nullable, Maximum length: 10

Returns:

A fluent helper to fetch a single ProductClass 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.

getAllProductClassCharc

@Nonnull
ProductClassCharcFluentHelper getAllProductClassCharc()

Fetch multiple ProductClassCharc entities.

Returns:

A fluent helper to fetch multiple ProductClassCharc 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.

getProductClassCharcByKey

@Nonnull
ProductClassCharcByKeyFluentHelper getProductClassCharcByKey(String product,
                                                                      String classInternalID,
                                                                      String charcInternalID)

Fetch a single ProductClassCharc entity using key fields.

Parameters:

product - Key of Object to be Classified

Constraints: Not nullable, Maximum length: 90

charcInternalID - Characteristic Internal ID

Constraints: Not nullable, Maximum length: 10

classInternalID - Internal Class Number

Constraints: Not nullable, Maximum length: 10

Returns:

A fluent helper to fetch a single ProductClassCharc 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.