@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultCentralPurchaseContractService") public class DefaultCentralPurchaseContractService extends Object implements CentralPurchaseContractService
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.
Reference: SAP API Business Hub
| 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 |
| Business Object: | CentralPurchaseContract |
DEFAULT_SERVICE_PATH| Constructor and Description |
|---|
DefaultCentralPurchaseContractService()
Creates a service using
CentralPurchaseContractService.DEFAULT_SERVICE_PATH to send the requests. |
public DefaultCentralPurchaseContractService()
CentralPurchaseContractService.DEFAULT_SERVICE_PATH to send the requests.@Nonnull public DefaultCentralPurchaseContractService withServicePath(@Nonnull String servicePath)
CentralPurchaseContractServicewithServicePath in interface CentralPurchaseContractServiceservicePath - Service path that will override the default.@Nonnull public DefaultCentralPurchaseContractServiceBatch batch()
batch in interface BatchService<CentralPurchaseContractServiceBatch>@Nonnull public CentralPurchaseContractFluentHelper getAllCentralPurchaseContract()
CentralPurchaseContractServiceCentralPurchaseContract entities.getAllCentralPurchaseContract in interface CentralPurchaseContractServiceCentralPurchaseContract 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.@Nonnull public CentralPurchaseContractByKeyFluentHelper getCentralPurchaseContractByKey(String centralPurchaseContract)
CentralPurchaseContractServiceCentralPurchaseContract entity using key fields.getCentralPurchaseContractByKey in interface CentralPurchaseContractServicecentralPurchaseContract - The active purchasing document number of a purchasing document.
Constraints: Not nullable, Maximum length: 10
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.@Nonnull public CentralPurchaseContractCreateFluentHelper createCentralPurchaseContract(@Nonnull CentralPurchaseContract centralPurchaseContract)
CentralPurchaseContractServiceCentralPurchaseContract entity and save it to the S/4HANA system.createCentralPurchaseContract in interface CentralPurchaseContractServicecentralPurchaseContract - CentralPurchaseContract entity object that will be created in the S/4HANA system.CentralPurchaseContract entity. To perform execution, call the
execute method on the fluent helper object.@Nonnull public CntrlPurchaseContractItemFluentHelper getAllCntrlPurchaseContractItem()
CentralPurchaseContractServiceCntrlPurchaseContractItem entities.getAllCntrlPurchaseContractItem in interface CentralPurchaseContractServiceCntrlPurchaseContractItem 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.@Nonnull public CntrlPurchaseContractItemByKeyFluentHelper getCntrlPurchaseContractItemByKey(String centralPurchaseContract, String centralPurchaseContractItem)
CentralPurchaseContractServiceCntrlPurchaseContractItem entity using key fields.getCntrlPurchaseContractItemByKey in interface CentralPurchaseContractServicecentralPurchaseContract - Central Purchase Contract
Constraints: Not nullable, Maximum length: 10
centralPurchaseContractItem - Central Purchase Contract Item
Constraints: Not nullable, Maximum length: 5
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.@Nonnull public CntrlPurContractHeaderNotesFluentHelper getAllCntrlPurContractHeaderNotes()
CentralPurchaseContractServiceCntrlPurContractHeaderNotes entities.getAllCntrlPurContractHeaderNotes in interface CentralPurchaseContractServiceCntrlPurContractHeaderNotes 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.@Nonnull public CntrlPurContractHeaderNotesByKeyFluentHelper getCntrlPurContractHeaderNotesByKey(String purchasingDocumentNoteObjectID, String purchasingDocumentNoteType, String purchasingDocumentNoteLanguage)
CentralPurchaseContractServiceCntrlPurContractHeaderNotes entity using key fields.getCntrlPurContractHeaderNotesByKey in interface CentralPurchaseContractServicepurchasingDocumentNoteObjectID - Application Object ID
Constraints: Not nullable, Maximum length: 90
purchasingDocumentNoteType - Name of Note Type
Constraints: Not nullable, Maximum length: 20
purchasingDocumentNoteLanguage - Language
Constraints: Not nullable, Maximum length: 2
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.@Nonnull public CntrlPurContractItemNotesFluentHelper getAllCntrlPurContractItemNotes()
CentralPurchaseContractServiceCntrlPurContractItemNotes entities.getAllCntrlPurContractItemNotes in interface CentralPurchaseContractServiceCntrlPurContractItemNotes 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.@Nonnull public CntrlPurContractItemNotesByKeyFluentHelper getCntrlPurContractItemNotesByKey(String purchasingDocumentNoteObjectID, String purchasingDocumentNoteType, String purchasingDocumentNoteLanguage)
CentralPurchaseContractServiceCntrlPurContractItemNotes entity using key fields.getCntrlPurContractItemNotesByKey in interface CentralPurchaseContractServicepurchasingDocumentNoteObjectID - Application Object ID
Constraints: Not nullable, Maximum length: 90
purchasingDocumentNoteType - Name of Note Type
Constraints: Not nullable, Maximum length: 20
purchasingDocumentNoteLanguage - Language
Constraints: Not nullable, Maximum length: 2
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.@Nonnull public CntrlPurContrDistrMessagesFluentHelper getAllCntrlPurContrDistrMessages()
CentralPurchaseContractServiceCntrlPurContrDistrMessages entities.getAllCntrlPurContrDistrMessages in interface CentralPurchaseContractServiceCntrlPurContrDistrMessages 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.@Nonnull public CntrlPurContrDistrMessagesByKeyFluentHelper getCntrlPurContrDistrMessagesByKey(String sequenceNumber, UUID distrResponseMessageUUID)
CentralPurchaseContractServiceCntrlPurContrDistrMessages entity using key fields.getCntrlPurContrDistrMessagesByKey in interface CentralPurchaseContractServicesequenceNumber - Sequence No. of Message during Contract Distribution
Constraints: Not nullable, Maximum length: 4
distrResponseMessageUUID - Generic Data Element for GUID Fields (X16)
Constraints: Not nullable
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.@Nonnull public CntrlPurContrHdrDistributionFluentHelper getAllCntrlPurContrHdrDistribution()
CentralPurchaseContractServiceCntrlPurContrHdrDistribution entities.getAllCntrlPurContrHdrDistribution in interface CentralPurchaseContractServiceCntrlPurContrHdrDistribution 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.@Nonnull public CntrlPurContrHdrDistributionByKeyFluentHelper getCntrlPurContrHdrDistributionByKey(String centralPurchaseContract, String distributionKey)
CentralPurchaseContractServiceCntrlPurContrHdrDistribution entity using key fields.getCntrlPurContrHdrDistributionByKey in interface CentralPurchaseContractServicecentralPurchaseContract - Alphanumeric key uniquely identifying the document.
Constraints: Not nullable, Maximum length: 10
distributionKey - Distribution Number of Central Purchasing Document
Constraints: Not nullable, Maximum length: 4
CntrlPurContrHdrDistribution 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.@Nonnull public CntrlPurContrHeaderPartnerFluentHelper getAllCntrlPurContrHeaderPartner()
CentralPurchaseContractServiceCntrlPurContrHeaderPartner entities.getAllCntrlPurContrHeaderPartner in interface CentralPurchaseContractServiceCntrlPurContrHeaderPartner 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.@Nonnull public CntrlPurContrHeaderPartnerByKeyFluentHelper getCntrlPurContrHeaderPartnerByKey(String centralPurchaseContract, String distributionKey, String partnerCounter)
CentralPurchaseContractServiceCntrlPurContrHeaderPartner entity using key fields.getCntrlPurContrHeaderPartnerByKey in interface CentralPurchaseContractServicecentralPurchaseContract - Alphanumeric key uniquely identifying the document.
Constraints: Not nullable, Maximum length: 10
distributionKey - Distribution Number of Central Purchasing Document
Constraints: Not nullable, Maximum length: 4
partnerCounter - The sequential number that the system applies when there is more than one partner for a particular
partner function.
Constraints: Not nullable, Maximum length: 3
CntrlPurContrHeaderPartner 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.@Nonnull public CntrlPurContrItemPartnerFluentHelper getAllCntrlPurContrItemPartner()
CentralPurchaseContractServiceCntrlPurContrItemPartner entities.getAllCntrlPurContrItemPartner in interface CentralPurchaseContractServiceCntrlPurContrItemPartner 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.@Nonnull public CntrlPurContrItemPartnerByKeyFluentHelper getCntrlPurContrItemPartnerByKey(String centralPurchaseContract, String centralPurchaseContractItem, String distributionKey, String partnerCounter)
CentralPurchaseContractServiceCntrlPurContrItemPartner entity using key fields.getCntrlPurContrItemPartnerByKey in interface CentralPurchaseContractServicecentralPurchaseContract - 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
partnerCounter - The sequential number that the system applies when there is more than one partner for a particular
partner function.
Constraints: Not nullable, Maximum length: 3
CntrlPurContrItemPartner 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.@Nonnull public CntrlPurContrItmCndnAmountFluentHelper getAllCntrlPurContrItmCndnAmount()
CentralPurchaseContractServiceCntrlPurContrItmCndnAmount entities.getAllCntrlPurContrItmCndnAmount in interface CentralPurchaseContractServiceCntrlPurContrItmCndnAmount 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.@Nonnull public CntrlPurContrItmCndnAmountByKeyFluentHelper getCntrlPurContrItmCndnAmountByKey(String centralPurchaseContract, String centralPurchaseContractItem, String conditionRecord, LocalDateTime conditionValidityEndDate, String conditionSequentialNumber)
CentralPurchaseContractServiceCntrlPurContrItmCndnAmount entity using key fields.getCntrlPurContrItmCndnAmountByKey in interface CentralPurchaseContractServicecentralPurchaseContract - 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
conditionRecord - Number that uniquely identifies a condition record.
Constraints: Not nullable, Maximum length: 10
conditionValidityEndDate - The date up to which the condition is valid.
Constraints: Not nullable, Precision: 0
conditionSequentialNumber - The sequential number that uniquely identifies the condition if a condition supplement exists.
Constraints: Not nullable, Maximum length: 2
CntrlPurContrItmCndnAmount 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.@Nonnull public CntrlPurContrItmCndnScalesFluentHelper getAllCntrlPurContrItmCndnScales()
CentralPurchaseContractServiceCntrlPurContrItmCndnScales entities.getAllCntrlPurContrItmCndnScales in interface CentralPurchaseContractServiceCntrlPurContrItmCndnScales 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.@Nonnull public CntrlPurContrItmCndnScalesByKeyFluentHelper getCntrlPurContrItmCndnScalesByKey(String centralPurchaseContract, String centralPurchaseContractItem, String conditionRecord, String conditionSequentialNumber, LocalDateTime conditionValidityEndDate, String conditionScaleLine)
CentralPurchaseContractServiceCntrlPurContrItmCndnScales entity using key fields.getCntrlPurContrItmCndnScalesByKey in interface CentralPurchaseContractServicecentralPurchaseContract - 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
conditionRecord - Number that uniquely identifies a condition record.
Constraints: Not nullable, Maximum length: 10
conditionSequentialNumber - The sequential number that uniquely identifies the condition if a condition supplement exists.
Constraints: Not nullable, Maximum length: 2
conditionValidityEndDate - The date up to which the condition is valid.
Constraints: Not nullable, Precision: 0
conditionScaleLine - Identifies the sequence of lines within a scale.
Constraints: Not nullable, Maximum length: 4
CntrlPurContrItmCndnScales 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.@Nonnull public CntrlPurContrItmCndnValdtyFluentHelper getAllCntrlPurContrItmCndnValdty()
CentralPurchaseContractServiceCntrlPurContrItmCndnValdty entities.getAllCntrlPurContrItmCndnValdty in interface CentralPurchaseContractServiceCntrlPurContrItmCndnValdty 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.@Nonnull public CntrlPurContrItmCndnValdtyByKeyFluentHelper getCntrlPurContrItmCndnValdtyByKey(String centralPurchaseContract, String centralPurchaseContractItem, String conditionRecord, LocalDateTime conditionValidityEndDate)
CentralPurchaseContractServiceCntrlPurContrItmCndnValdty entity using key fields.getCntrlPurContrItmCndnValdtyByKey in interface CentralPurchaseContractServicecentralPurchaseContract - 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
conditionRecord - Number that uniquely identifies a condition record.
Constraints: Not nullable, Maximum length: 10
conditionValidityEndDate - The date up to which the condition is valid.
Constraints: Not nullable, Precision: 0
CntrlPurContrItmCndnValdty 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.@Nonnull public CntrlPurContrItmDistributionFluentHelper getAllCntrlPurContrItmDistribution()
CentralPurchaseContractServiceCntrlPurContrItmDistribution entities.getAllCntrlPurContrItmDistribution in interface CentralPurchaseContractServiceCntrlPurContrItmDistribution 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.@Nonnull public CntrlPurContrItmDistributionByKeyFluentHelper getCntrlPurContrItmDistributionByKey(String centralPurchaseContract, String centralPurchaseContractItem, String distributionKey)
CentralPurchaseContractServiceCntrlPurContrItmDistribution entity using key fields.getCntrlPurContrItmDistributionByKey in interface CentralPurchaseContractServicecentralPurchaseContract - 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
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.@Nonnull public CntrlPurContrLegalTransFluentHelper getAllCntrlPurContrLegalTrans()
CentralPurchaseContractServiceCntrlPurContrLegalTrans entities.getAllCntrlPurContrLegalTrans in interface CentralPurchaseContractServiceCntrlPurContrLegalTrans 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.@Nonnull public CntrlPurContrLegalTransByKeyFluentHelper getCntrlPurContrLegalTransByKey(String centralPurchaseContract, String legalTransaction)
CentralPurchaseContractServiceCntrlPurContrLegalTrans entity using key fields.getCntrlPurContrLegalTransByKey in interface CentralPurchaseContractServicecentralPurchaseContract - Central Purchase Contract
Constraints: Not nullable, Maximum length: 10
legalTransaction - Legal Transaction ID
Constraints: Not nullable, Maximum length: 10
CntrlPurContrLegalTrans 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.@Nonnull public CntrlPurContrVersionHistoryFluentHelper getAllCntrlPurContrVersionHistory()
CentralPurchaseContractServiceCntrlPurContrVersionHistory entities.getAllCntrlPurContrVersionHistory in interface CentralPurchaseContractServiceCntrlPurContrVersionHistory 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.@Nonnull public CntrlPurContrVersionHistoryByKeyFluentHelper getCntrlPurContrVersionHistoryByKey(String centralPurchaseContract, String purchasingDocumentVersion)
CentralPurchaseContractServiceCntrlPurContrVersionHistory entity using key fields.getCntrlPurContrVersionHistoryByKey in interface CentralPurchaseContractServicecentralPurchaseContract - The active purchasing document number of a purchasing document.
Constraints: Not nullable, Maximum length: 10
purchasingDocumentVersion - Number uniquely identifying a version of a purchasing document.
Constraints: Not nullable, Maximum length: 8
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.@Nonnull public SubordinateCntrlContractFluentHelper getAllSubordinateCntrlContract()
CentralPurchaseContractServiceSubordinateCntrlContract entities.getAllSubordinateCntrlContract in interface CentralPurchaseContractServiceSubordinateCntrlContract 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.@Nonnull public SubordinateCntrlContractByKeyFluentHelper getSubordinateCntrlContractByKey(String purchasingParentDocument, String subordCntrlPurContract, String procmtHubCompanyCodeGroupingID)
CentralPurchaseContractServiceSubordinateCntrlContract entity using key fields.getSubordinateCntrlContractByKey in interface CentralPurchaseContractServicepurchasingParentDocument - The parent document ID of a subordinate purchasing document.
Constraints: Not nullable, Maximum length: 10
subordCntrlPurContract - The active purchasing document number of a purchasing document.
Constraints: Not nullable, Maximum length: 10
procmtHubCompanyCodeGroupingID - The ID of the collection under which company codes of different connected systems are grouped.
Constraints: Not nullable, Maximum length: 3
SubordinateCntrlContract 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.@Nonnull public WithdrawFromApprovalFluentHelper withdrawFromApproval(@Nonnull String centralPurchaseContract)
CentralPurchaseContractServiceCreates a fluent helper for the WithdrawFromApproval OData function import.
withdrawFromApproval in interface CentralPurchaseContractServicecentralPurchaseContract - Central Purchase Contract
Constraints: none
Original parameter name from the Odata EDM: CentralPurchaseContract
execute method on the fluent helper object.@Nonnull public AssignLegalTransactionFluentHelper assignLegalTransaction(@Nonnull String legalTransactionId, @Nonnull String centralPurchaseContract)
CentralPurchaseContractServiceCreates a fluent helper for the AssignLegalTransaction OData function import.
assignLegalTransaction in interface CentralPurchaseContractServicelegalTransactionId - Constraints: none
Original parameter name from the Odata EDM: LegalTransactionId
centralPurchaseContract - Constraints: none
Original parameter name from the Odata EDM: CentralPurchaseContract
execute method on the fluent helper object.Copyright © 2021 SAP SE. All rights reserved.