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

Interface CentralPurchaseContractService

All Superinterfaces:

BatchService<CentralPurchaseContractServiceBatch>

All Known Implementing Classes:

DefaultCentralPurchaseContractService

public interface CentralPurchaseContractService
extends BatchService<CentralPurchaseContractServiceBatch>

With this inbound service, you can read and create a central purchase contract which allows purchasers from various parts of the company at different locations to take advantage of the negotiated global agreement with suppliers.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_CENTRAL_PURCHASECONTRACT_SRV
API Version:	1
Communication Scenario:	SAP S/4HANA Procurement Hub - Central Contract Management Integration (SAP_COM_0243)
Scope Items:	Central Purchase Contracts (2ME)
Authentication Methods:	Basic, x509

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
CentralPurchaseContractCreateFluentHelper	createCentralPurchaseContract(CentralPurchaseContract centralPurchaseContract) Create a new CentralPurchaseContract entity and save it to the S/4HANA system.
CentralPurchaseContractFluentHelper	getAllCentralPurchaseContract() Fetch multiple CentralPurchaseContract entities.
CntrlPurchaseContractItemFluentHelper	getAllCntrlPurchaseContractItem() Fetch multiple CntrlPurchaseContractItem entities.
CntrlPurContrDistrMessagesFluentHelper	getAllCntrlPurContrDistrMessages() Fetch multiple CntrlPurContrDistrMessages entities.
CntrlPurContrItmDistributionFluentHelper	getAllCntrlPurContrItmDistribution() Fetch multiple CntrlPurContrItmDistribution entities.
CentralPurchaseContractByKeyFluentHelper	getCentralPurchaseContractByKey(String centralPurchaseContract) Fetch a single CentralPurchaseContract entity using key fields.
CntrlPurchaseContractItemByKeyFluentHelper	getCntrlPurchaseContractItemByKey(String centralPurchaseContract, String centralPurchaseContractItem) Fetch a single CntrlPurchaseContractItem entity using key fields.
CntrlPurContrDistrMessagesByKeyFluentHelper	getCntrlPurContrDistrMessagesByKey(String sequenceNumber, UUID distrResponseMessageUUID) Fetch a single CntrlPurContrDistrMessages entity using key fields.
CntrlPurContrItmDistributionByKeyFluentHelper	getCntrlPurContrItmDistributionByKey(String centralPurchaseContract, String centralPurchaseContractItem, String distributionKey) Fetch a single CntrlPurContrItmDistribution entity using key fields.
CentralPurchaseContractService	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.s4hana.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
CentralPurchaseContractService 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.

getAllCentralPurchaseContract

@Nonnull
CentralPurchaseContractFluentHelper getAllCentralPurchaseContract()

Fetch multiple CentralPurchaseContract entities.

Returns:

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

getCentralPurchaseContractByKey

@Nonnull
CentralPurchaseContractByKeyFluentHelper getCentralPurchaseContractByKey(String centralPurchaseContract)

Fetch a single CentralPurchaseContract entity using key fields.

Parameters:

centralPurchaseContract - Central Purchase Contract

Constraints: Not nullable, Maximum length: 10

Returns:

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

createCentralPurchaseContract

@Nonnull
CentralPurchaseContractCreateFluentHelper createCentralPurchaseContract(@Nonnull
                                                                                 CentralPurchaseContract centralPurchaseContract)

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

Parameters:

centralPurchaseContract - CentralPurchaseContract entity object that will be created in the S/4HANA system.

Returns:

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

getAllCntrlPurchaseContractItem

@Nonnull
CntrlPurchaseContractItemFluentHelper getAllCntrlPurchaseContractItem()

Fetch multiple CntrlPurchaseContractItem entities.

Returns:

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

getCntrlPurchaseContractItemByKey

@Nonnull
CntrlPurchaseContractItemByKeyFluentHelper getCntrlPurchaseContractItemByKey(String centralPurchaseContract,
                                                                                      String centralPurchaseContractItem)

Fetch a single CntrlPurchaseContractItem entity using key fields.

Parameters:

centralPurchaseContract - Central Purchase Contract

Constraints: Not nullable, Maximum length: 10

centralPurchaseContractItem - Central Purchase Contract Item

Constraints: Not nullable, Maximum length: 5

Returns:

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

getAllCntrlPurContrDistrMessages

@Nonnull
CntrlPurContrDistrMessagesFluentHelper getAllCntrlPurContrDistrMessages()

Fetch multiple CntrlPurContrDistrMessages entities.

Returns:

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

getCntrlPurContrDistrMessagesByKey

@Nonnull
CntrlPurContrDistrMessagesByKeyFluentHelper getCntrlPurContrDistrMessagesByKey(String sequenceNumber,
                                                                                        UUID distrResponseMessageUUID)

Fetch a single CntrlPurContrDistrMessages entity using key fields.

Parameters:

sequenceNumber - Sequence No. of Message during Contract Distribution

Constraints: Not nullable, Maximum length: 4

distrResponseMessageUUID - Generic Data Element for GUID Fields (X16)

Constraints: Not nullable

Returns:

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

getAllCntrlPurContrItmDistribution

@Nonnull
CntrlPurContrItmDistributionFluentHelper getAllCntrlPurContrItmDistribution()

Fetch multiple CntrlPurContrItmDistribution entities.

Returns:

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

getCntrlPurContrItmDistributionByKey

@Nonnull
CntrlPurContrItmDistributionByKeyFluentHelper getCntrlPurContrItmDistributionByKey(String centralPurchaseContract,
                                                                                            String centralPurchaseContractItem,
                                                                                            String distributionKey)

Fetch a single CntrlPurContrItmDistribution entity using key fields.

Parameters:

distributionKey - Distribution Number of Central Purchasing Document

Constraints: Not nullable, Maximum length: 4

centralPurchaseContract - Alphanumeric key uniquely identifying the document.

Constraints: Not nullable, Maximum length: 10

centralPurchaseContractItem - Specifies the number that uniquely identifies an item in .

Constraints: Not nullable, Maximum length: 5

Returns:

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