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

Interface CentralPurchaseContractService

All Superinterfaces:

BatchService<CentralPurchaseContractServiceBatch>

All Known Implementing Classes:

DefaultCentralPurchaseContractService

public interface CentralPurchaseContractService
extends BatchService<CentralPurchaseContractServiceBatch>

This service is based on the OData protocol. It allows purchasers from various parts of the company at different locations to take advantage of the negotiated global agreement with suppliers. This service contains header, item, item distribution entities, distribution messages, header notes, item notes, and version history. .

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	OP_API_CENTRAL_PURCHASECONTRACT_SRV
API Version:	1
Minimum ERP Version:	2020
Authentication Methods:	Basic, x509
Business Object:	Central Purchase Contract

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.
CntrlPurContractHeaderNotesFluentHelper	getAllCntrlPurContractHeaderNotes() Fetch multiple CntrlPurContractHeaderNotes entities.
CntrlPurContractItemNotesFluentHelper	getAllCntrlPurContractItemNotes() Fetch multiple CntrlPurContractItemNotes entities.
CntrlPurContrDistrMessagesFluentHelper	getAllCntrlPurContrDistrMessages() Fetch multiple CntrlPurContrDistrMessages entities.
CntrlPurContrItmDistributionFluentHelper	getAllCntrlPurContrItmDistribution() Fetch multiple CntrlPurContrItmDistribution entities.
CntrlPurContrVersionHistoryFluentHelper	getAllCntrlPurContrVersionHistory() Fetch multiple CntrlPurContrVersionHistory 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.
CntrlPurContractHeaderNotesByKeyFluentHelper	getCntrlPurContractHeaderNotesByKey(String purchasingDocumentNoteObjectID, String purchasingDocumentNoteType, String purchasingDocumentNoteLanguage) Fetch a single CntrlPurContractHeaderNotes entity using key fields.
CntrlPurContractItemNotesByKeyFluentHelper	getCntrlPurContractItemNotesByKey(String purchasingDocumentNoteObjectID, String purchasingDocumentNoteType, String purchasingDocumentNoteLanguage) Fetch a single CntrlPurContractItemNotes 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.
CntrlPurContrVersionHistoryByKeyFluentHelper	getCntrlPurContrVersionHistoryByKey(String centralPurchaseContract, String purchasingDocumentVersion) Fetch a single CntrlPurContrVersionHistory entity using key fields.
WithdrawFromApprovalFluentHelper	withdrawFromApproval(String centralPurchaseContract) Creates a fluent helper for the WithdrawFromApproval OData function import.
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.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 - Active Purchasing Document

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.

getAllCntrlPurContractHeaderNotes

@Nonnull
CntrlPurContractHeaderNotesFluentHelper getAllCntrlPurContractHeaderNotes()

Fetch multiple CntrlPurContractHeaderNotes entities.

Returns:

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

getCntrlPurContractHeaderNotesByKey

@Nonnull
CntrlPurContractHeaderNotesByKeyFluentHelper getCntrlPurContractHeaderNotesByKey(String purchasingDocumentNoteObjectID,
                                                                                          String purchasingDocumentNoteType,
                                                                                          String purchasingDocumentNoteLanguage)

Fetch a single CntrlPurContractHeaderNotes entity using key fields.

Parameters:

purchasingDocumentNoteLanguage - Language

Constraints: Not nullable, Maximum length: 2

purchasingDocumentNoteObjectID - Application Object ID

Constraints: Not nullable, Maximum length: 90

purchasingDocumentNoteType - Name of Note Type

Constraints: Not nullable, Maximum length: 20

Returns:

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

getAllCntrlPurContractItemNotes

@Nonnull
CntrlPurContractItemNotesFluentHelper getAllCntrlPurContractItemNotes()

Fetch multiple CntrlPurContractItemNotes entities.

Returns:

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

getCntrlPurContractItemNotesByKey

@Nonnull
CntrlPurContractItemNotesByKeyFluentHelper getCntrlPurContractItemNotesByKey(String purchasingDocumentNoteObjectID,
                                                                                      String purchasingDocumentNoteType,
                                                                                      String purchasingDocumentNoteLanguage)

Fetch a single CntrlPurContractItemNotes entity using key fields.

Parameters:

purchasingDocumentNoteLanguage - Language

Constraints: Not nullable, Maximum length: 2

purchasingDocumentNoteObjectID - Application Object ID

Constraints: Not nullable, Maximum length: 90

purchasingDocumentNoteType - Name of Note Type

Constraints: Not nullable, Maximum length: 20

Returns:

A fluent helper to fetch a single CntrlPurContractItemNotes 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 - Purchasing Document Number

Constraints: Not nullable, Maximum length: 10

centralPurchaseContractItem - Item Number of Purchasing Document

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.

getAllCntrlPurContrVersionHistory

@Nonnull
CntrlPurContrVersionHistoryFluentHelper getAllCntrlPurContrVersionHistory()

Fetch multiple CntrlPurContrVersionHistory entities.

Returns:

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

getCntrlPurContrVersionHistoryByKey

@Nonnull
CntrlPurContrVersionHistoryByKeyFluentHelper getCntrlPurContrVersionHistoryByKey(String centralPurchaseContract,
                                                                                          String purchasingDocumentVersion)

Fetch a single CntrlPurContrVersionHistory entity using key fields.

Parameters:

purchasingDocumentVersion - Version number in Purchasing

Constraints: Not nullable, Maximum length: 8

centralPurchaseContract - Active Purchasing Document

Constraints: Not nullable, Maximum length: 10

Returns:

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

withdrawFromApproval

@Nonnull
WithdrawFromApprovalFluentHelper withdrawFromApproval(String centralPurchaseContract)

Creates a fluent helper for the WithdrawFromApproval OData function import.

Parameters:

centralPurchaseContract - Constraints: none

Original parameter name from the Odata EDM: CentralPurchaseContract

Returns:

A fluent helper object that will execute the WithdrawFromApproval OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.