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

Interface ProductAllocationObjectService

All Known Implementing Classes:

DefaultProductAllocationObjectService

public interface ProductAllocationObjectService

Product Allocation (PAL) in SAP S/4HANA is used to determine the availability of requested products by checking against sales data as well as data for restricted resources (materials and/or capacity) consumed along the value chain of the requested product. Restricted resources and sales rules are organized in time series, these packages of supply are referred to as product allocations. Critical situations in demand and (internal and external) procurement processes can therefore be avoided by factoring sales and supply restrictions into the product availability check. You can use this service to read data for product allocation objects such as header data, characteristic metadata, characteristic values and their time series (period, quantity, unit of measure). In addition, you can create and edit the characteristic values and time series data from external planning systems such as: SAP Merchandise and Assortment Planning (AMR). SAP Assortment Planning for Retail (APR). SAP Integrated Business Planning (IBP). Any other planning systems.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_PRODUCT_ALLOCATION_OBJECT_SRV
API Version:	1
Communication Scenario:	Product Allocation Object Integration (SAP_COM_0152)
Scope Items:	Advanced Available-to-Promise Processing (1JW)

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
ProdAllocCharcValCombnCreateFluentHelper	createProdAllocCharcValCombn(ProdAllocCharcValCombn prodAllocCharcValCombn) Create a new ProdAllocCharcValCombn entity and save it to the S/4HANA system.
ProdAllocObjTimeSeriesCreateFluentHelper	createProdAllocObjTimeSeries(ProdAllocObjTimeSeries prodAllocObjTimeSeries) Create a new ProdAllocObjTimeSeries entity and save it to the S/4HANA system.
ProdAllocationObjectFluentHelper	getAllProdAllocationObject() Fetch multiple ProdAllocationObject entities.
ProdAllocationObjectTFluentHelper	getAllProdAllocationObjectT() Fetch multiple ProdAllocationObjectT entities.
ProdAllocCharcMetaDataFluentHelper	getAllProdAllocCharcMetaData() Fetch multiple ProdAllocCharcMetaData entities.
ProdAllocCharcValCombnFluentHelper	getAllProdAllocCharcValCombn() Fetch multiple ProdAllocCharcValCombn entities.
ProdAllocObjTimeSeriesFluentHelper	getAllProdAllocObjTimeSeries() Fetch multiple ProdAllocObjTimeSeries entities.
ProdAllocationObjectByKeyFluentHelper	getProdAllocationObjectByKey(UUID productAllocationObjectUUID) Fetch a single ProdAllocationObject entity using key fields.
ProdAllocationObjectTByKeyFluentHelper	getProdAllocationObjectTByKey(UUID productAllocationObjectUUID, String language) Fetch a single ProdAllocationObjectT entity using key fields.
ProdAllocCharcMetaDataByKeyFluentHelper	getProdAllocCharcMetaDataByKey(UUID characteristicsMetaDataUUID) Fetch a single ProdAllocCharcMetaData entity using key fields.
ProdAllocCharcValCombnByKeyFluentHelper	getProdAllocCharcValCombnByKey(UUID charcValueCombinationUUID) Fetch a single ProdAllocCharcValCombn entity using key fields.
ProdAllocObjTimeSeriesByKeyFluentHelper	getProdAllocObjTimeSeriesByKey(UUID prodAllocationTimeSeriesUUID) Fetch a single ProdAllocObjTimeSeries entity using key fields.
ProdAllocCharcValCombnUpdateFluentHelper	updateProdAllocCharcValCombn(ProdAllocCharcValCombn prodAllocCharcValCombn) Update an existing ProdAllocCharcValCombn entity and save it to the S/4HANA system.
ProdAllocObjTimeSeriesUpdateFluentHelper	updateProdAllocObjTimeSeries(ProdAllocObjTimeSeries prodAllocObjTimeSeries) Update an existing ProdAllocObjTimeSeries entity and save it to the S/4HANA system.
ProductAllocationObjectService	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

@Nonnull
ProductAllocationObjectService 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.

getAllProdAllocCharcMetaData

@Nonnull
ProdAllocCharcMetaDataFluentHelper getAllProdAllocCharcMetaData()

Fetch multiple ProdAllocCharcMetaData entities.

Returns:

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

getProdAllocCharcMetaDataByKey

@Nonnull
ProdAllocCharcMetaDataByKeyFluentHelper getProdAllocCharcMetaDataByKey(UUID characteristicsMetaDataUUID)

Fetch a single ProdAllocCharcMetaData entity using key fields.

Parameters:

characteristicsMetaDataUUID - Characteristic Meta Data UUID

Constraints: Not nullable

Returns:

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

getAllProdAllocCharcValCombn

@Nonnull
ProdAllocCharcValCombnFluentHelper getAllProdAllocCharcValCombn()

Fetch multiple ProdAllocCharcValCombn entities.

Returns:

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

getProdAllocCharcValCombnByKey

@Nonnull
ProdAllocCharcValCombnByKeyFluentHelper getProdAllocCharcValCombnByKey(UUID charcValueCombinationUUID)

Fetch a single ProdAllocCharcValCombn entity using key fields.

Parameters:

charcValueCombinationUUID - Characteristic Value Combination UUID

Constraints: Not nullable

Returns:

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

createProdAllocCharcValCombn

@Nonnull
ProdAllocCharcValCombnCreateFluentHelper createProdAllocCharcValCombn(@Nonnull
                                                                               ProdAllocCharcValCombn prodAllocCharcValCombn)

Create a new ProdAllocCharcValCombn entity and save it to the S/4HANA system.

Parameters:

prodAllocCharcValCombn - ProdAllocCharcValCombn entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new ProdAllocCharcValCombn entity. To perform execution, call the execute method on the fluent helper object.

updateProdAllocCharcValCombn

@Nonnull
ProdAllocCharcValCombnUpdateFluentHelper updateProdAllocCharcValCombn(@Nonnull
                                                                               ProdAllocCharcValCombn prodAllocCharcValCombn)

Update an existing ProdAllocCharcValCombn entity and save it to the S/4HANA system.

Parameters:

prodAllocCharcValCombn - ProdAllocCharcValCombn entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing ProdAllocCharcValCombn entity. To perform execution, call the execute method on the fluent helper object.

getAllProdAllocObjTimeSeries

@Nonnull
ProdAllocObjTimeSeriesFluentHelper getAllProdAllocObjTimeSeries()

Fetch multiple ProdAllocObjTimeSeries entities.

Returns:

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

getProdAllocObjTimeSeriesByKey

@Nonnull
ProdAllocObjTimeSeriesByKeyFluentHelper getProdAllocObjTimeSeriesByKey(UUID prodAllocationTimeSeriesUUID)

Fetch a single ProdAllocObjTimeSeries entity using key fields.

Parameters:

prodAllocationTimeSeriesUUID - Product Allocation Time SeriesUUID

Constraints: Not nullable

Returns:

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

createProdAllocObjTimeSeries

@Nonnull
ProdAllocObjTimeSeriesCreateFluentHelper createProdAllocObjTimeSeries(@Nonnull
                                                                               ProdAllocObjTimeSeries prodAllocObjTimeSeries)

Create a new ProdAllocObjTimeSeries entity and save it to the S/4HANA system.

Parameters:

prodAllocObjTimeSeries - ProdAllocObjTimeSeries entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new ProdAllocObjTimeSeries entity. To perform execution, call the execute method on the fluent helper object.

updateProdAllocObjTimeSeries

@Nonnull
ProdAllocObjTimeSeriesUpdateFluentHelper updateProdAllocObjTimeSeries(@Nonnull
                                                                               ProdAllocObjTimeSeries prodAllocObjTimeSeries)

Update an existing ProdAllocObjTimeSeries entity and save it to the S/4HANA system.

Parameters:

prodAllocObjTimeSeries - ProdAllocObjTimeSeries entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing ProdAllocObjTimeSeries entity. To perform execution, call the execute method on the fluent helper object.

getAllProdAllocationObject

@Nonnull
ProdAllocationObjectFluentHelper getAllProdAllocationObject()

Fetch multiple ProdAllocationObject entities.

Returns:

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

getProdAllocationObjectByKey

@Nonnull
ProdAllocationObjectByKeyFluentHelper getProdAllocationObjectByKey(UUID productAllocationObjectUUID)

Fetch a single ProdAllocationObject entity using key fields.

Parameters:

productAllocationObjectUUID - Product Allocation Object UUID

Constraints: Not nullable

Returns:

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

getAllProdAllocationObjectT

@Nonnull
ProdAllocationObjectTFluentHelper getAllProdAllocationObjectT()

Fetch multiple ProdAllocationObjectT entities.

Returns:

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

getProdAllocationObjectTByKey

@Nonnull
ProdAllocationObjectTByKeyFluentHelper getProdAllocationObjectTByKey(UUID productAllocationObjectUUID,
                                                                              String language)

Fetch a single ProdAllocationObjectT entity using key fields.

Parameters:

language - Language Key

Constraints: Not nullable, Maximum length: 2

productAllocationObjectUUID - Product Allocation Object UUID

Constraints: Not nullable

Returns:

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