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

Interface RawSubstanceService

All Known Implementing Classes:

DefaultRawSubstanceService

public interface RawSubstanceService

You use this service to read raw substance attributes, such as header data or composition via an OData service.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_RAWSUBSTANCE
API Version:	1
Communication Scenario:	Product Lifecycle Management - Recipe Development Integration (SAP_COM_0136)
Scope Items:	Formulation - Recipe Development (1QC)

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
ProductFluentHelper	getAllProduct() Fetch multiple Product entities.
ProductDescriptionFluentHelper	getAllProductDescription() Fetch multiple ProductDescription entities.
ProductPlantFluentHelper	getAllProductPlant() Fetch multiple ProductPlant entities.
ProductSalesDeliveryFluentHelper	getAllProductSalesDelivery() Fetch multiple ProductSalesDelivery entities.
ProductStorageLocationFluentHelper	getAllProductStorageLocation() Fetch multiple ProductStorageLocation entities.
RawSubstanceFluentHelper	getAllRawSubstance() Fetch multiple RawSubstance entities.
SpecAssignedMatlForKeyDateFluentHelper	getAllSpecAssignedMatlForKeyDate() Fetch multiple SpecAssignedMatlForKeyDate entities.
SpecAuthorizationGroupTextFluentHelper	getAllSpecAuthorizationGroupText() Fetch multiple SpecAuthorizationGroupText entities.
SpecCharByValueAssgmtInstFluentHelper	getAllSpecCharByValueAssgmtInst() Fetch multiple SpecCharByValueAssgmtInst entities.
SpecIdentifierFluentHelper	getAllSpecIdentifier() Fetch multiple SpecIdentifier entities.
SpecStatusAttributesFluentHelper	getAllSpecStatusAttributes() Fetch multiple SpecStatusAttributes entities.
SpecStatusNextStatusFluentHelper	getAllSpecStatusNextStatus() Fetch multiple SpecStatusNextStatus entities.
SpecStatusSchemaFluentHelper	getAllSpecStatusSchema() Fetch multiple SpecStatusSchema entities.
SpecValAssgmtInstanceWthCompFluentHelper	getAllSpecValAssgmtInstanceWthComp() Fetch multiple SpecValAssgmtInstanceWthComp entities.
ProductByKeyFluentHelper	getProductByKey(String product) Fetch a single Product 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.
ProductSalesDeliveryByKeyFluentHelper	getProductSalesDeliveryByKey(String product, String productSalesOrg, String productDistributionChnl) Fetch a single ProductSalesDelivery entity using key fields.
ProductStorageLocationByKeyFluentHelper	getProductStorageLocationByKey(String product, String plant, String storageLocation) Fetch a single ProductStorageLocation entity using key fields.
RawSubstanceByKeyFluentHelper	getRawSubstanceByKey(String rawSubstanceInternalID) Fetch a single RawSubstance entity using key fields.
SpecAssignedMatlForKeyDateByKeyFluentHelper	getSpecAssignedMatlForKeyDateByKey(String specMaterialAssgmtInternalID, String specMaterialAssgmtChangeState) Fetch a single SpecAssignedMatlForKeyDate entity using key fields.
SpecAuthorizationGroupTextByKeyFluentHelper	getSpecAuthorizationGroupTextByKey(String specificationAuthznGroup, String language) Fetch a single SpecAuthorizationGroupText entity using key fields.
SpecCharByValueAssgmtInstByKeyFluentHelper	getSpecCharByValueAssgmtInstByKey(String specificationInternalID, String specValAssgmtType, String specificationRating, String specificationValidityArea) Fetch a single SpecCharByValueAssgmtInst entity using key fields.
SpecIdentifierByKeyFluentHelper	getSpecIdentifierByKey(String specIdfgDescInternalID, String specIdfgDescChangeState) Fetch a single SpecIdentifier entity using key fields.
SpecStatusAttributesByKeyFluentHelper	getSpecStatusAttributesByKey(String specificationHeaderStatus, String specificationHdrStsAttribute) Fetch a single SpecStatusAttributes entity using key fields.
SpecStatusNextStatusByKeyFluentHelper	getSpecStatusNextStatusByKey(String specificationHdrStsSchema, String specificationHdrStsSchemaFrSts, String specificationHdrStsSchemaToSts) Fetch a single SpecStatusNextStatus entity using key fields.
SpecStatusSchemaByKeyFluentHelper	getSpecStatusSchemaByKey(String specificationType, String specificationHdrStsSchema) Fetch a single SpecStatusSchema entity using key fields.
SpecValAssgmtInstanceWthCompByKeyFluentHelper	getSpecValAssgmtInstanceWthCompByKey(String specificationInternalID, String specValAssgmtType, String specificationRating, String specificationValidityArea, String componentSpecificationIntID) Fetch a single SpecValAssgmtInstanceWthComp entity using key fields.
RawSubstanceService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

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

RawSubstanceService 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

getAllProduct

@Nonnull
ProductFluentHelper getAllProduct()

Fetch multiple Product entities.

Returns:

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

getProductByKey

@Nonnull
ProductByKeyFluentHelper getProductByKey(String product)

Fetch a single Product entity using key fields.

Parameters:

product - Product Number

Constraints: Not nullable, Maximum length: 40

Returns:

A fluent helper to fetch a single Product 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 - Product Number

Constraints: Not nullable, Maximum length: 40

language - Language Key

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 - Material Number

Constraints: Not nullable, Maximum length: 40

plant - 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 - Product Number

Constraints: Not nullable, Maximum length: 40

productDistributionChnl - Distribution Channel

Constraints: Not nullable, Maximum length: 2

productSalesOrg - Sales Organization

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.

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 - Material Number

Constraints: Not nullable, Maximum length: 40

plant - Plant

Constraints: Not nullable, Maximum length: 4

storageLocation - Storage Location

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.

getAllRawSubstance

@Nonnull
RawSubstanceFluentHelper getAllRawSubstance()

Fetch multiple RawSubstance entities.

Returns:

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

getRawSubstanceByKey

@Nonnull
RawSubstanceByKeyFluentHelper getRawSubstanceByKey(String rawSubstanceInternalID)

Fetch a single RawSubstance entity using key fields.

Parameters:

rawSubstanceInternalID - Sequential Number of Data Record

Constraints: Not nullable, Maximum length: 20

Returns:

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

getAllSpecAssignedMatlForKeyDate

@Nonnull
SpecAssignedMatlForKeyDateFluentHelper getAllSpecAssignedMatlForKeyDate()

Fetch multiple SpecAssignedMatlForKeyDate entities.

Returns:

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

getSpecAssignedMatlForKeyDateByKey

@Nonnull
SpecAssignedMatlForKeyDateByKeyFluentHelper getSpecAssignedMatlForKeyDateByKey(String specMaterialAssgmtInternalID,
                                                                                        String specMaterialAssgmtChangeState)

Fetch a single SpecAssignedMatlForKeyDate entity using key fields.

Parameters:

specMaterialAssgmtInternalID - Sequential Number of Data Record

Constraints: Not nullable, Maximum length: 20

specMaterialAssgmtChangeState - Sequential Number of the Change State

Constraints: Not nullable, Maximum length: 20

Returns:

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

getAllSpecAuthorizationGroupText

@Nonnull
SpecAuthorizationGroupTextFluentHelper getAllSpecAuthorizationGroupText()

Fetch multiple SpecAuthorizationGroupText entities.

Returns:

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

getSpecAuthorizationGroupTextByKey

@Nonnull
SpecAuthorizationGroupTextByKeyFluentHelper getSpecAuthorizationGroupTextByKey(String specificationAuthznGroup,
                                                                                        String language)

Fetch a single SpecAuthorizationGroupText entity using key fields.

Parameters:

specificationAuthznGroup - Recipe Authorization Group

Constraints: Not nullable, Maximum length: 10

language - Language Key

Constraints: Not nullable, Maximum length: 2

Returns:

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

getAllSpecCharByValueAssgmtInst

@Nonnull
SpecCharByValueAssgmtInstFluentHelper getAllSpecCharByValueAssgmtInst()

Fetch multiple SpecCharByValueAssgmtInst entities.

Returns:

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

getSpecCharByValueAssgmtInstByKey

@Nonnull
SpecCharByValueAssgmtInstByKeyFluentHelper getSpecCharByValueAssgmtInstByKey(String specificationInternalID,
                                                                                      String specValAssgmtType,
                                                                                      String specificationRating,
                                                                                      String specificationValidityArea)

Fetch a single SpecCharByValueAssgmtInst entity using key fields.

Parameters:

specValAssgmtType - Value Assignment Type

Constraints: Not nullable, Maximum length: 30

specificationRating - Rating

Constraints: Not nullable, Maximum length: 10

specificationValidityArea - Validity Area

Constraints: Not nullable, Maximum length: 10

specificationInternalID - Sequential Number of Data Record

Constraints: Not nullable, Maximum length: 20

Returns:

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

getAllSpecIdentifier

@Nonnull
SpecIdentifierFluentHelper getAllSpecIdentifier()

Fetch multiple SpecIdentifier entities.

Returns:

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

getSpecIdentifierByKey

@Nonnull
SpecIdentifierByKeyFluentHelper getSpecIdentifierByKey(String specIdfgDescInternalID,
                                                                String specIdfgDescChangeState)

Fetch a single SpecIdentifier entity using key fields.

Parameters:

specIdfgDescInternalID - Sequential Number of Data Record

Constraints: Not nullable, Maximum length: 20

specIdfgDescChangeState - Sequential Number of the Change State

Constraints: Not nullable, Maximum length: 20

Returns:

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

getAllSpecStatusAttributes

@Nonnull
SpecStatusAttributesFluentHelper getAllSpecStatusAttributes()

Fetch multiple SpecStatusAttributes entities.

Returns:

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

getSpecStatusAttributesByKey

@Nonnull
SpecStatusAttributesByKeyFluentHelper getSpecStatusAttributesByKey(String specificationHeaderStatus,
                                                                            String specificationHdrStsAttribute)

Fetch a single SpecStatusAttributes entity using key fields.

Parameters:

specificationHeaderStatus - Status Identification

Constraints: Not nullable, Maximum length: 20

specificationHdrStsAttribute - Attribute per Object Type

Constraints: Not nullable, Maximum length: 20

Returns:

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

getAllSpecStatusNextStatus

@Nonnull
SpecStatusNextStatusFluentHelper getAllSpecStatusNextStatus()

Fetch multiple SpecStatusNextStatus entities.

Returns:

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

getSpecStatusNextStatusByKey

@Nonnull
SpecStatusNextStatusByKeyFluentHelper getSpecStatusNextStatusByKey(String specificationHdrStsSchema,
                                                                            String specificationHdrStsSchemaFrSts,
                                                                            String specificationHdrStsSchemaToSts)

Fetch a single SpecStatusNextStatus entity using key fields.

Parameters:

specificationHdrStsSchema - Status Scheme

Constraints: Not nullable, Maximum length: 20

specificationHdrStsSchemaToSts - Status To

Constraints: Not nullable, Maximum length: 20

specificationHdrStsSchemaFrSts - Status Identification

Constraints: Not nullable, Maximum length: 20

Returns:

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

getAllSpecStatusSchema

@Nonnull
SpecStatusSchemaFluentHelper getAllSpecStatusSchema()

Fetch multiple SpecStatusSchema entities.

Returns:

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

getSpecStatusSchemaByKey

@Nonnull
SpecStatusSchemaByKeyFluentHelper getSpecStatusSchemaByKey(String specificationType,
                                                                    String specificationHdrStsSchema)

Fetch a single SpecStatusSchema entity using key fields.

Parameters:

specificationHdrStsSchema - Status Scheme

Constraints: Not nullable, Maximum length: 20

specificationType - Subordinate Object Type

Constraints: Not nullable, Maximum length: 20

Returns:

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

getAllSpecValAssgmtInstanceWthComp

@Nonnull
SpecValAssgmtInstanceWthCompFluentHelper getAllSpecValAssgmtInstanceWthComp()

Fetch multiple SpecValAssgmtInstanceWthComp entities.

Returns:

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

getSpecValAssgmtInstanceWthCompByKey

@Nonnull
SpecValAssgmtInstanceWthCompByKeyFluentHelper getSpecValAssgmtInstanceWthCompByKey(String specificationInternalID,
                                                                                            String specValAssgmtType,
                                                                                            String specificationRating,
                                                                                            String specificationValidityArea,
                                                                                            String componentSpecificationIntID)

Fetch a single SpecValAssgmtInstanceWthComp entity using key fields.

Parameters:

specValAssgmtType - Value Assignment Type

Constraints: Not nullable, Maximum length: 30

specificationRating - Rating

Constraints: Not nullable, Maximum length: 10

componentSpecificationIntID - Reference to Specification Header of a Component

Constraints: Not nullable, Maximum length: 20

specificationValidityArea - Validity Area

Constraints: Not nullable, Maximum length: 10

specificationInternalID - Sequential Number of Data Record

Constraints: Not nullable, Maximum length: 20

Returns:

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