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

Class DefaultCentralPurchaseContractService

java.lang.Object

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

All Implemented Interfaces:

BatchService<CentralPurchaseContractServiceBatch>, CentralPurchaseContractService

@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultCentralPurchaseContractService")
public class DefaultCentralPurchaseContractService
extends Object
implements CentralPurchaseContractService

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 inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.CentralPurchaseContractService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultCentralPurchaseContractService() Creates a service using CentralPurchaseContractService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
DefaultCentralPurchaseContractServiceBatch	batch() Instantiate a new FluentHelper instance for a single OData batch request.
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.
DefaultCentralPurchaseContractService	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

DefaultCentralPurchaseContractService

public DefaultCentralPurchaseContractService()

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

Method Detail

withServicePath

@Nonnull
public DefaultCentralPurchaseContractService withServicePath(@Nonnull
                                                                      String servicePath)

Description copied from interface: CentralPurchaseContractService

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 CentralPurchaseContractService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultCentralPurchaseContractServiceBatch batch()

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

Specified by:

batch in interface BatchService<CentralPurchaseContractServiceBatch>

Returns:

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

getAllCentralPurchaseContract

@Nonnull
public CentralPurchaseContractFluentHelper getAllCentralPurchaseContract()

Description copied from interface: CentralPurchaseContractService

Fetch multiple CentralPurchaseContract entities.

Specified by:

getAllCentralPurchaseContract in interface CentralPurchaseContractService

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
public CentralPurchaseContractByKeyFluentHelper getCentralPurchaseContractByKey(String centralPurchaseContract)

Description copied from interface: CentralPurchaseContractService

Fetch a single CentralPurchaseContract entity using key fields.

Specified by:

getCentralPurchaseContractByKey in interface CentralPurchaseContractService

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
public CentralPurchaseContractCreateFluentHelper createCentralPurchaseContract(@Nonnull
                                                                                        CentralPurchaseContract centralPurchaseContract)

Description copied from interface: CentralPurchaseContractService

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

Specified by:

createCentralPurchaseContract in interface CentralPurchaseContractService

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
public CntrlPurchaseContractItemFluentHelper getAllCntrlPurchaseContractItem()

Description copied from interface: CentralPurchaseContractService

Fetch multiple CntrlPurchaseContractItem entities.

Specified by:

getAllCntrlPurchaseContractItem in interface CentralPurchaseContractService

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
public CntrlPurchaseContractItemByKeyFluentHelper getCntrlPurchaseContractItemByKey(String centralPurchaseContract,
                                                                                             String centralPurchaseContractItem)

Description copied from interface: CentralPurchaseContractService

Fetch a single CntrlPurchaseContractItem entity using key fields.

Specified by:

getCntrlPurchaseContractItemByKey in interface CentralPurchaseContractService

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
public CntrlPurContrDistrMessagesFluentHelper getAllCntrlPurContrDistrMessages()

Description copied from interface: CentralPurchaseContractService

Fetch multiple CntrlPurContrDistrMessages entities.

Specified by:

getAllCntrlPurContrDistrMessages in interface CentralPurchaseContractService

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
public CntrlPurContrDistrMessagesByKeyFluentHelper getCntrlPurContrDistrMessagesByKey(String sequenceNumber,
                                                                                               UUID distrResponseMessageUUID)

Description copied from interface: CentralPurchaseContractService

Fetch a single CntrlPurContrDistrMessages entity using key fields.

Specified by:

getCntrlPurContrDistrMessagesByKey in interface CentralPurchaseContractService

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
public CntrlPurContrItmDistributionFluentHelper getAllCntrlPurContrItmDistribution()

Description copied from interface: CentralPurchaseContractService

Fetch multiple CntrlPurContrItmDistribution entities.

Specified by:

getAllCntrlPurContrItmDistribution in interface CentralPurchaseContractService

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
public CntrlPurContrItmDistributionByKeyFluentHelper getCntrlPurContrItmDistributionByKey(String centralPurchaseContract,
                                                                                                   String centralPurchaseContractItem,
                                                                                                   String distributionKey)

Description copied from interface: CentralPurchaseContractService

Fetch a single CntrlPurContrItmDistribution entity using key fields.

Specified by:

getCntrlPurContrItmDistributionByKey in interface CentralPurchaseContractService

Parameters:

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

distributionKey - Distribution Number of Central Purchasing Document

Constraints: Not nullable, Maximum length: 4

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.