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

Class DefaultProductAllocationSequenceService

java.lang.Object

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

All Implemented Interfaces:

BatchService<ProductAllocationSequenceServiceBatch>, ProductAllocationSequenceService

@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultProductAllocationSequenceService")
public class DefaultProductAllocationSequenceService
extends Object
implements 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 inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.ProductAllocationSequenceService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultProductAllocationSequenceService() Creates a service using ProductAllocationSequenceService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
DefaultProductAllocationSequenceServiceBatch	batch() Instantiate a new FluentHelper instance for a single OData batch request.
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.
DefaultProductAllocationSequenceService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultProductAllocationSequenceService

public DefaultProductAllocationSequenceService()

Creates a service using ProductAllocationSequenceService.DEFAULT_SERVICE_PATH to send the requests.

Method Detail

withServicePath

@Nonnull
public DefaultProductAllocationSequenceService withServicePath(@Nonnull
                                                                        String servicePath)

Description copied from interface: ProductAllocationSequenceService

Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.

Specified by:

withServicePath in interface ProductAllocationSequenceService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultProductAllocationSequenceServiceBatch batch()

Instantiate a new FluentHelper instance for a single OData batch request.

Specified by:

batch in interface BatchService<ProductAllocationSequenceServiceBatch>

Returns:

A new instance of an OData batch request associated with the service object.

getAllProdAllocSequenceT

@Nonnull
public ProdAllocSequenceTFluentHelper getAllProdAllocSequenceT()

Description copied from interface: ProductAllocationSequenceService

Fetch multiple ProdAllocSequenceT entities.

Specified by:

getAllProdAllocSequenceT in interface ProductAllocationSequenceService

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
public ProdAllocSequenceTByKeyFluentHelper getProdAllocSequenceTByKey(UUID productAllocationSequenceUUID,
                                                                               String language)

Description copied from interface: ProductAllocationSequenceService

Fetch a single ProdAllocSequenceT entity using key fields.

Specified by:

getProdAllocSequenceTByKey in interface ProductAllocationSequenceService

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
public ProdAllocSqncAssgmtFluentHelper getAllProdAllocSqncAssgmt()

Description copied from interface: ProductAllocationSequenceService

Fetch multiple ProdAllocSqncAssgmt entities.

Specified by:

getAllProdAllocSqncAssgmt in interface ProductAllocationSequenceService

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
public ProdAllocSqncAssgmtByKeyFluentHelper getProdAllocSqncAssgmtByKey(UUID prodAllocSqncAssignmentUUID)

Description copied from interface: ProductAllocationSequenceService

Fetch a single ProdAllocSqncAssgmt entity using key fields.

Specified by:

getProdAllocSqncAssgmtByKey in interface ProductAllocationSequenceService

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
public ProdAllocSqncAssgmtCreateFluentHelper createProdAllocSqncAssgmt(@Nonnull
                                                                                ProdAllocSqncAssgmt prodAllocSqncAssgmt)

Description copied from interface: ProductAllocationSequenceService

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

Specified by:

createProdAllocSqncAssgmt in interface ProductAllocationSequenceService

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
public ProdAllocSqncAssgmtUpdateFluentHelper updateProdAllocSqncAssgmt(@Nonnull
                                                                                ProdAllocSqncAssgmt prodAllocSqncAssgmt)

Description copied from interface: ProductAllocationSequenceService

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

Specified by:

updateProdAllocSqncAssgmt in interface ProductAllocationSequenceService

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
public ProdAllocationSequenceFluentHelper getAllProdAllocationSequence()

Description copied from interface: ProductAllocationSequenceService

Fetch multiple ProdAllocationSequence entities.

Specified by:

getAllProdAllocationSequence in interface ProductAllocationSequenceService

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
public ProdAllocationSequenceByKeyFluentHelper getProdAllocationSequenceByKey(UUID productAllocationSequenceUUID)

Description copied from interface: ProductAllocationSequenceService

Fetch a single ProdAllocationSequence entity using key fields.

Specified by:

getProdAllocationSequenceByKey in interface ProductAllocationSequenceService

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.