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

Interface ProductAllocationSequenceService

All Known Implementing Classes:

DefaultProductAllocationSequenceService

public interface ProductAllocationSequenceService

Product allocation (in the following PAL) is an S/4HANA functionality that determines the availability of requested product(s) by checking against sales data and/or bottleneck resource data, which could be materials and/or capacity consumed along the value chain of the requested product. The supply of bottleneck resources and sales rules are organized in time buckets. These packages of supply along the time stream are called product (resource) allocations. This functionality shall enable companies to avoid critical situations in the demand and procurement (internal and external) processes by factoring sales restrictions and supply chain bottlenecks in the product availability check. The PAL functionality is also a bridge between the supply chain planning tools such as Integrated Business Planning (IBP) and the order fulfilment functionalities of S/4HANA. Usually the PAL data will be planned in special planning systems. The result of such plan processes is a huge amount of PAL data which have to be maintained into the PAL object and also a huge amount of products/articles which have to be assigned into a Product Allocation Sequence. The Product Allocation Sequence itself is linked to a Product Allocation Object. This integration scenario enables the customer to insert/update the product/article assignments into a given Product Allocation Sequence from an external system, like IBP (Integrated Business Planning), APR (Assortment Planning for Retailing), AMR, and Simple Excel Planning.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_PRODUCT_ALLOC_SEQUENCE_SRV
API Version:	1
Communication Scenario:	Product Allocation Sequence Integration (SAP_COM_0161)
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
ProdAllocSqncAssgmtCreateFluentHelper	createProdAllocSqncAssgmt(ProdAllocSqncAssgmt prodAllocSqncAssgmt) Create a new ProdAllocSqncAssgmt entity and save it to the S/4HANA system.
ProdAllocationSequenceFluentHelper	getAllProdAllocationSequence() Fetch multiple ProdAllocationSequence entities.
ProdAllocSequenceTFluentHelper	getAllProdAllocSequenceT() Fetch multiple ProdAllocSequenceT entities.
ProdAllocSqncAssgmtFluentHelper	getAllProdAllocSqncAssgmt() Fetch multiple ProdAllocSqncAssgmt entities.
ProdAllocationSequenceByKeyFluentHelper	getProdAllocationSequenceByKey(UUID productAllocationSequenceUUID) Fetch a single ProdAllocationSequence entity using key fields.
ProdAllocSequenceTByKeyFluentHelper	getProdAllocSequenceTByKey(UUID productAllocationSequenceUUID, String language) Fetch a single ProdAllocSequenceT entity using key fields.
ProdAllocSqncAssgmtByKeyFluentHelper	getProdAllocSqncAssgmtByKey(UUID prodAllocSqncAssignmentUUID) Fetch a single ProdAllocSqncAssgmt entity using key fields.
ProdAllocSqncAssgmtUpdateFluentHelper	updateProdAllocSqncAssgmt(ProdAllocSqncAssgmt prodAllocSqncAssgmt) Update an existing ProdAllocSqncAssgmt entity and save it to the S/4HANA system.
ProductAllocationSequenceService	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

ProductAllocationSequenceService 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

getAllProdAllocSequenceT

@Nonnull
ProdAllocSequenceTFluentHelper getAllProdAllocSequenceT()

Fetch multiple ProdAllocSequenceT entities.

Returns:

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

getProdAllocSequenceTByKey

@Nonnull
ProdAllocSequenceTByKeyFluentHelper getProdAllocSequenceTByKey(UUID productAllocationSequenceUUID,
                                                                        String language)

Fetch a single ProdAllocSequenceT entity using key fields.

Parameters:

productAllocationSequenceUUID - Product Allocation Sequence UUID

Constraints: Not nullable

language - Language Key

Constraints: Not nullable, Maximum length: 2

Returns:

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

getAllProdAllocSqncAssgmt

@Nonnull
ProdAllocSqncAssgmtFluentHelper getAllProdAllocSqncAssgmt()

Fetch multiple ProdAllocSqncAssgmt entities.

Returns:

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

getProdAllocSqncAssgmtByKey

@Nonnull
ProdAllocSqncAssgmtByKeyFluentHelper getProdAllocSqncAssgmtByKey(UUID prodAllocSqncAssignmentUUID)

Fetch a single ProdAllocSqncAssgmt entity using key fields.

Parameters:

prodAllocSqncAssignmentUUID - Product Allocation Sequence Assignment UUID

Constraints: Not nullable

Returns:

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

createProdAllocSqncAssgmt

@Nonnull
ProdAllocSqncAssgmtCreateFluentHelper createProdAllocSqncAssgmt(@Nonnull
                                                                         ProdAllocSqncAssgmt prodAllocSqncAssgmt)

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

Parameters:

prodAllocSqncAssgmt - ProdAllocSqncAssgmt entity object that will be created in the S/4HANA system.

Returns:

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

updateProdAllocSqncAssgmt

@Nonnull
ProdAllocSqncAssgmtUpdateFluentHelper updateProdAllocSqncAssgmt(@Nonnull
                                                                         ProdAllocSqncAssgmt prodAllocSqncAssgmt)

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

Parameters:

prodAllocSqncAssgmt - ProdAllocSqncAssgmt entity object that will be updated in the S/4HANA system.

Returns:

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

getAllProdAllocationSequence

@Nonnull
ProdAllocationSequenceFluentHelper getAllProdAllocationSequence()

Fetch multiple ProdAllocationSequence entities.

Returns:

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

getProdAllocationSequenceByKey

@Nonnull
ProdAllocationSequenceByKeyFluentHelper getProdAllocationSequenceByKey(UUID productAllocationSequenceUUID)

Fetch a single ProdAllocationSequence entity using key fields.

Parameters:

productAllocationSequenceUUID - Product Allocation Sequence UUID

Constraints: Not nullable

Returns:

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