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

Interface PurchasingQuotaArrangementService

All Superinterfaces:

BatchService<PurchasingQuotaArrangementServiceBatch>

All Known Implementing Classes:

DefaultPurchasingQuotaArrangementService

public interface PurchasingQuotaArrangementService
extends BatchService<PurchasingQuotaArrangementServiceBatch>

This service helps you to create, read, update, and delete quota arrangements through an API call from a source system outside SAP S/4HANA Cloud or SAP S/4HANA. The service contains quota arrangement header and item. The information is sent in the request as a payload. The information is used when creating, reading or updating a quota arrangement, with appropriate checks for restricted values and authorizations.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_PUR_QUOTA_ARRANGEMENT_SRV
API Version:	1
Communication Scenario:	Purchasing Quota Arrangement Integration (SAP_COM_0166)
Scope Items:	Scheduling Agreements in Procurement (BMR), Physical Inventory - Inventory Count and Adjustment (OML)
Authentication Methods:	Basic, x509
Business Object:	PurchasingQuotaArrangement

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
PurchasingQuotaArrangementCreateFluentHelper	createPurchasingQuotaArrangement(PurchasingQuotaArrangement purchasingQuotaArrangement) Create a new PurchasingQuotaArrangement entity and save it to the S/4HANA system.
PurchasingQuotaArrangementDeleteFluentHelper	deletePurchasingQuotaArrangement(PurchasingQuotaArrangement purchasingQuotaArrangement) Deletes an existing PurchasingQuotaArrangement entity in the S/4HANA system.
PurgQuotaArrangementItemDeleteFluentHelper	deletePurgQuotaArrangementItem(PurgQuotaArrangementItem purgQuotaArrangementItem) Deletes an existing PurgQuotaArrangementItem entity in the S/4HANA system.
PurchasingQuotaArrangementFluentHelper	getAllPurchasingQuotaArrangement() Fetch multiple PurchasingQuotaArrangement entities.
PurgQuotaArrangementItemFluentHelper	getAllPurgQuotaArrangementItem() Fetch multiple PurgQuotaArrangementItem entities.
PurchasingQuotaArrangementByKeyFluentHelper	getPurchasingQuotaArrangementByKey(String quotaArrangement) Fetch a single PurchasingQuotaArrangement entity using key fields.
PurgQuotaArrangementItemByKeyFluentHelper	getPurgQuotaArrangementItemByKey(String quotaArrangement, String quotaArrangementItem) Fetch a single PurgQuotaArrangementItem entity using key fields.
PurchasingQuotaArrangementUpdateFluentHelper	updatePurchasingQuotaArrangement(PurchasingQuotaArrangement purchasingQuotaArrangement) Update an existing PurchasingQuotaArrangement entity and save it to the S/4HANA system.
PurgQuotaArrangementItemUpdateFluentHelper	updatePurgQuotaArrangementItem(PurgQuotaArrangementItem purgQuotaArrangementItem) Update an existing PurgQuotaArrangementItem entity and save it to the S/4HANA system.
PurchasingQuotaArrangementService	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
PurchasingQuotaArrangementService 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.

getAllPurchasingQuotaArrangement

@Nonnull
PurchasingQuotaArrangementFluentHelper getAllPurchasingQuotaArrangement()

Fetch multiple PurchasingQuotaArrangement entities.

Returns:

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

getPurchasingQuotaArrangementByKey

@Nonnull
PurchasingQuotaArrangementByKeyFluentHelper getPurchasingQuotaArrangementByKey(String quotaArrangement)

Fetch a single PurchasingQuotaArrangement entity using key fields.

Parameters:

quotaArrangement - Uniquely identifies the quota arrangement.

Constraints: Not nullable, Maximum length: 10

Returns:

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

createPurchasingQuotaArrangement

@Nonnull
PurchasingQuotaArrangementCreateFluentHelper createPurchasingQuotaArrangement(@Nonnull
                                                                                       PurchasingQuotaArrangement purchasingQuotaArrangement)

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

Parameters:

purchasingQuotaArrangement - PurchasingQuotaArrangement entity object that will be created in the S/4HANA system.

Returns:

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

updatePurchasingQuotaArrangement

@Nonnull
PurchasingQuotaArrangementUpdateFluentHelper updatePurchasingQuotaArrangement(@Nonnull
                                                                                       PurchasingQuotaArrangement purchasingQuotaArrangement)

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

Parameters:

purchasingQuotaArrangement - PurchasingQuotaArrangement entity object that will be updated in the S/4HANA system.

Returns:

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

deletePurchasingQuotaArrangement

@Nonnull
PurchasingQuotaArrangementDeleteFluentHelper deletePurchasingQuotaArrangement(@Nonnull
                                                                                       PurchasingQuotaArrangement purchasingQuotaArrangement)

Deletes an existing PurchasingQuotaArrangement entity in the S/4HANA system.

Parameters:

purchasingQuotaArrangement - PurchasingQuotaArrangement entity object that will be deleted in the S/4HANA system.

Returns:

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

getAllPurgQuotaArrangementItem

@Nonnull
PurgQuotaArrangementItemFluentHelper getAllPurgQuotaArrangementItem()

Fetch multiple PurgQuotaArrangementItem entities.

Returns:

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

getPurgQuotaArrangementItemByKey

@Nonnull
PurgQuotaArrangementItemByKeyFluentHelper getPurgQuotaArrangementItemByKey(String quotaArrangement,
                                                                                    String quotaArrangementItem)

Fetch a single PurgQuotaArrangementItem entity using key fields.

Parameters:

quotaArrangement - Uniquely identifies the quota arrangement.

Constraints: Not nullable, Maximum length: 10

quotaArrangementItem - Uniquely identifies the quota arrangement item within a quota arrangement period.

Constraints: Not nullable, Maximum length: 3

Returns:

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

updatePurgQuotaArrangementItem

@Nonnull
PurgQuotaArrangementItemUpdateFluentHelper updatePurgQuotaArrangementItem(@Nonnull
                                                                                   PurgQuotaArrangementItem purgQuotaArrangementItem)

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

Parameters:

purgQuotaArrangementItem - PurgQuotaArrangementItem entity object that will be updated in the S/4HANA system.

Returns:

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

deletePurgQuotaArrangementItem

@Nonnull
PurgQuotaArrangementItemDeleteFluentHelper deletePurgQuotaArrangementItem(@Nonnull
                                                                                   PurgQuotaArrangementItem purgQuotaArrangementItem)

Deletes an existing PurgQuotaArrangementItem entity in the S/4HANA system.

Parameters:

purgQuotaArrangementItem - PurgQuotaArrangementItem entity object that will be deleted in the S/4HANA system.

Returns:

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