DefaultPurchaseContractService (SAP Cloud SDK

java.lang.Object
- com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultPurchaseContractService

All Implemented Interfaces:: BatchService<PurchaseContractServiceBatch>, PurchaseContractService

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

This service enables you to read, create, and update purchase contracts through an API call from a source system outside SAP S/4HANA Cloud. The service contains header, item, item conditions, account assignment, address and partner nodes. .

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_PURCHASECONTRACT_PROCESS_SRV
API Version:	1
Communication Scenario:	Distributed Manufacturing Integration (SAP_COM_0077), Purchase Contract Integration (SAP_COM_0101)
Scope Items:	Collaborative Manufacturing with SAP Digital Manufacturing Cloud (1NX), Purchase Contract (BMD), Consumable Purchasing (BNX), Service and Material Procurement - Project-Based Services (J13), Procurement of Direct Materials (J45), Dynamic Customer Profiling (JC1)
Authentication Methods:	Basic, x509

Field Summary
- Fields inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.PurchaseContractService
  DEFAULT_SERVICE_PATH

Constructor Summary

Constructors
Constructor and Description

DefaultPurchaseContractService()
Creates a service using PurchaseContractService.DEFAULT_SERVICE_PATH to send the requests.

Constructors
Constructor and Description
`DefaultPurchaseContractService()` Creates a service using `PurchaseContractService.DEFAULT_SERVICE_PATH` to send the requests.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DefaultPurchaseContractServiceBatch`	`batch()` Instantiate a new FluentHelper instance for a single OData batch request.
`PurchaseContractCreateFluentHelper`	`createPurchaseContract(PurchaseContract purchaseContract)` Create a new `PurchaseContract` entity and save it to the S/4HANA system.
`PurchaseContractItemCreateFluentHelper`	`createPurchaseContractItem(PurchaseContractItem purchaseContractItem)` Create a new `PurchaseContractItem` entity and save it to the S/4HANA system.
`PurContrItemConditionCreateFluentHelper`	`createPurContrItemCondition(PurContrItemCondition purContrItemCondition)` Create a new `PurContrItemCondition` entity and save it to the S/4HANA system.
`PurchaseContractFluentHelper`	`getAllPurchaseContract()` Fetch multiple `PurchaseContract` entities.
`PurchaseContractItemFluentHelper`	`getAllPurchaseContractItem()` Fetch multiple `PurchaseContractItem` entities.
`PurContrItemConditionFluentHelper`	`getAllPurContrItemCondition()` Fetch multiple `PurContrItemCondition` entities.
`PurCtrAccountFluentHelper`	`getAllPurCtrAccount()` Fetch multiple `PurCtrAccount` entities.
`PurCtrAddressFluentHelper`	`getAllPurCtrAddress()` Fetch multiple `PurCtrAddress` entities.
`PurCtrPartnersFluentHelper`	`getAllPurCtrPartners()` Fetch multiple `PurCtrPartners` entities.
`PurchaseContractByKeyFluentHelper`	`getPurchaseContractByKey(String purchaseContract)` Fetch a single `PurchaseContract` entity using key fields.
`PurchaseContractItemByKeyFluentHelper`	`getPurchaseContractItemByKey(String purchaseContract, String purchaseContractItem)` Fetch a single `PurchaseContractItem` entity using key fields.
`PurContrItemConditionByKeyFluentHelper`	`getPurContrItemConditionByKey(String purchaseContract, String purchaseContractItem, LocalDateTime conditionValidityEndDate, String conditionType, String conditionRecord, String conditionSequentialNumber)` Fetch a single `PurContrItemCondition` entity using key fields.
`PurCtrAccountByKeyFluentHelper`	`getPurCtrAccountByKey(String accountAssignment, String purchaseContractItem, String purchaseContract)` Fetch a single `PurCtrAccount` entity using key fields.
`PurCtrAddressByKeyFluentHelper`	`getPurCtrAddressByKey(String purchaseContract, String addressID, String purchaseContractItem)` Fetch a single `PurCtrAddress` entity using key fields.
`PurCtrPartnersByKeyFluentHelper`	`getPurCtrPartnersByKey(String purchaseContract, String purchaseContractItem, String purchasingOrganization, String partnerFunction, String plant, String supplierSubrange, String partnerCounter)` Fetch a single `PurCtrPartners` entity using key fields.
`PurContrItemConditionUpdateFluentHelper`	`updatePurContrItemCondition(PurContrItemCondition purContrItemCondition)` Update an existing `PurContrItemCondition` entity and save it to the S/4HANA system.
`DefaultPurchaseContractService`	`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
  - DefaultPurchaseContractService
```
public DefaultPurchaseContractService()
```
    Creates a service using PurchaseContractService.DEFAULT_SERVICE_PATH to send the requests.
- Method Detail
  - withServicePath
```
@Nonnull
public DefaultPurchaseContractService withServicePath(@Nonnull
                                                               String servicePath)
```
    Description copied from interface: PurchaseContractService
    
    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 PurchaseContractService
    
    Parameters:
    
    servicePath - Service path that will override the default.
    
    Returns:
    
    A new service instance with the specified service path.
  - batch
```
@Nonnull
public DefaultPurchaseContractServiceBatch batch()
```
    Instantiate a new FluentHelper instance for a single OData batch request.
    
    Specified by:
    
    batch in interface BatchService<PurchaseContractServiceBatch>
    
    Returns:
    
    A new instance of an OData batch request associated with the service object.
  - getAllPurchaseContract
```
@Nonnull
public PurchaseContractFluentHelper getAllPurchaseContract()
```
    Description copied from interface: PurchaseContractService
    
    Fetch multiple PurchaseContract entities.
    
    Specified by:
    
    getAllPurchaseContract in interface PurchaseContractService
    
    Returns:
    
    A fluent helper to fetch multiple PurchaseContract 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.
  - getPurchaseContractByKey
```
@Nonnull
public PurchaseContractByKeyFluentHelper getPurchaseContractByKey(String purchaseContract)
```
    Description copied from interface: PurchaseContractService
    
    Fetch a single PurchaseContract entity using key fields.
    
    Specified by:
    
    getPurchaseContractByKey in interface PurchaseContractService
    
    Parameters:
    
    purchaseContract - Purchasing Contract Header
    Constraints: Not nullable, Maximum length: 10
    
    Returns:
    
    A fluent helper to fetch a single PurchaseContract 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.
  - createPurchaseContract
```
@Nonnull
public PurchaseContractCreateFluentHelper createPurchaseContract(@Nonnull
                                                                          PurchaseContract purchaseContract)
```
    Description copied from interface: PurchaseContractService
    
    Create a new PurchaseContract entity and save it to the S/4HANA system.
    
    Specified by:
    
    createPurchaseContract in interface PurchaseContractService
    
    Parameters:
    
    purchaseContract - PurchaseContract entity object that will be created in the S/4HANA system.
    
    Returns:
    
    A fluent helper to create a new PurchaseContract entity. To perform execution, call the execute method on the fluent helper object.
  - getAllPurchaseContractItem
```
@Nonnull
public PurchaseContractItemFluentHelper getAllPurchaseContractItem()
```
    Description copied from interface: PurchaseContractService
    
    Fetch multiple PurchaseContractItem entities.
    
    Specified by:
    
    getAllPurchaseContractItem in interface PurchaseContractService
    
    Returns:
    
    A fluent helper to fetch multiple PurchaseContractItem 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.
  - getPurchaseContractItemByKey
```
@Nonnull
public PurchaseContractItemByKeyFluentHelper getPurchaseContractItemByKey(String purchaseContract,
                                                                                   String purchaseContractItem)
```
    Description copied from interface: PurchaseContractService
    
    Fetch a single PurchaseContractItem entity using key fields.
    
    Specified by:
    
    getPurchaseContractItemByKey in interface PurchaseContractService
    
    Parameters:
    
    purchaseContract - Purchasing Contract Header
    Constraints: Not nullable, Maximum length: 10
    
    purchaseContractItem - Item Number of Purchasing Contract
    Constraints: Not nullable, Maximum length: 5
    
    Returns:
    
    A fluent helper to fetch a single PurchaseContractItem 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.
  - createPurchaseContractItem
```
@Nonnull
public PurchaseContractItemCreateFluentHelper createPurchaseContractItem(@Nonnull
                                                                                  PurchaseContractItem purchaseContractItem)
```
    Description copied from interface: PurchaseContractService
    
    Create a new PurchaseContractItem entity and save it to the S/4HANA system.
    
    Specified by:
    
    createPurchaseContractItem in interface PurchaseContractService
    
    Parameters:
    
    purchaseContractItem - PurchaseContractItem entity object that will be created in the S/4HANA system.
    
    Returns:
    
    A fluent helper to create a new PurchaseContractItem entity. To perform execution, call the execute method on the fluent helper object.
  - getAllPurContrItemCondition
```
@Nonnull
public PurContrItemConditionFluentHelper getAllPurContrItemCondition()
```
    Description copied from interface: PurchaseContractService
    
    Fetch multiple PurContrItemCondition entities.
    
    Specified by:
    
    getAllPurContrItemCondition in interface PurchaseContractService
    
    Returns:
    
    A fluent helper to fetch multiple PurContrItemCondition 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.
  - getPurContrItemConditionByKey
```
@Nonnull
public PurContrItemConditionByKeyFluentHelper getPurContrItemConditionByKey(String purchaseContract,
                                                                                     String purchaseContractItem,
                                                                                     LocalDateTime conditionValidityEndDate,
                                                                                     String conditionType,
                                                                                     String conditionRecord,
                                                                                     String conditionSequentialNumber)
```
    Description copied from interface: PurchaseContractService
    
    Fetch a single PurContrItemCondition entity using key fields.
    
    Specified by:
    
    getPurContrItemConditionByKey in interface PurchaseContractService
    
    Parameters:
    
    purchaseContract - Alphanumeric key uniquely identifying the document.
    Constraints: Not nullable, Maximum length: 10
    
    purchaseContractItem - Specifies the number that uniquely identifies an item in .
    Constraints: Not nullable, Maximum length: 5
    
    conditionType - The key that uniquely identifies the condition.
    Constraints: Not nullable, Maximum length: 4
    
    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
    
    Returns:
    
    A fluent helper to fetch a single PurContrItemCondition 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.
  - createPurContrItemCondition
```
@Nonnull
public PurContrItemConditionCreateFluentHelper createPurContrItemCondition(@Nonnull
                                                                                    PurContrItemCondition purContrItemCondition)
```
    Description copied from interface: PurchaseContractService
    
    Create a new PurContrItemCondition entity and save it to the S/4HANA system.
    
    Specified by:
    
    createPurContrItemCondition in interface PurchaseContractService
    
    Parameters:
    
    purContrItemCondition - PurContrItemCondition entity object that will be created in the S/4HANA system.
    
    Returns:
    
    A fluent helper to create a new PurContrItemCondition entity. To perform execution, call the execute method on the fluent helper object.
  - updatePurContrItemCondition
```
@Nonnull
public PurContrItemConditionUpdateFluentHelper updatePurContrItemCondition(@Nonnull
                                                                                    PurContrItemCondition purContrItemCondition)
```
    Description copied from interface: PurchaseContractService
    
    Update an existing PurContrItemCondition entity and save it to the S/4HANA system.
    
    Specified by:
    
    updatePurContrItemCondition in interface PurchaseContractService
    
    Parameters:
    
    purContrItemCondition - PurContrItemCondition entity object that will be updated in the S/4HANA system.
    
    Returns:
    
    A fluent helper to update an existing PurContrItemCondition entity. To perform execution, call the execute method on the fluent helper object.
  - getAllPurCtrAccount
```
@Nonnull
public PurCtrAccountFluentHelper getAllPurCtrAccount()
```
    Description copied from interface: PurchaseContractService
    
    Fetch multiple PurCtrAccount entities.
    
    Specified by:
    
    getAllPurCtrAccount in interface PurchaseContractService
    
    Returns:
    
    A fluent helper to fetch multiple PurCtrAccount 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.
  - getPurCtrAccountByKey
```
@Nonnull
public PurCtrAccountByKeyFluentHelper getPurCtrAccountByKey(String accountAssignment,
                                                                     String purchaseContractItem,
                                                                     String purchaseContract)
```
    Description copied from interface: PurchaseContractService
    
    Fetch a single PurCtrAccount entity using key fields.
    
    Specified by:
    
    getPurCtrAccountByKey in interface PurchaseContractService
    
    Parameters:
    
    accountAssignment - Number uniquely defining the account assignment of a purchase document item.
    Constraints: Not nullable, Maximum length: 2
    
    purchaseContractItem - Specifies the number that uniquely identifies an item in .
    Constraints: Not nullable, Maximum length: 5
    
    purchaseContract - Alphanumeric key uniquely identifying the document.
    Constraints: Not nullable, Maximum length: 10
    
    Returns:
    
    A fluent helper to fetch a single PurCtrAccount 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.
  - getAllPurCtrAddress
```
@Nonnull
public PurCtrAddressFluentHelper getAllPurCtrAddress()
```
    Description copied from interface: PurchaseContractService
    
    Fetch multiple PurCtrAddress entities.
    
    Specified by:
    
    getAllPurCtrAddress in interface PurchaseContractService
    
    Returns:
    
    A fluent helper to fetch multiple PurCtrAddress 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.
  - getPurCtrAddressByKey
```
@Nonnull
public PurCtrAddressByKeyFluentHelper getPurCtrAddressByKey(String purchaseContract,
                                                                     String addressID,
                                                                     String purchaseContractItem)
```
    Description copied from interface: PurchaseContractService
    
    Fetch a single PurCtrAddress entity using key fields.
    
    Specified by:
    
    getPurCtrAddressByKey in interface PurchaseContractService
    
    Parameters:
    
    purchaseContract - Purchasing Contract Header
    Constraints: Not nullable, Maximum length: 10
    
    addressID - Internal key for identifying a Business Address Services address.
    Constraints: Not nullable, Maximum length: 10
    
    purchaseContractItem - Item Number of Purchasing Contract
    Constraints: Not nullable, Maximum length: 5
    
    Returns:
    
    A fluent helper to fetch a single PurCtrAddress 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.
  - getAllPurCtrPartners
```
@Nonnull
public PurCtrPartnersFluentHelper getAllPurCtrPartners()
```
    Description copied from interface: PurchaseContractService
    
    Fetch multiple PurCtrPartners entities.
    
    Specified by:
    
    getAllPurCtrPartners in interface PurchaseContractService
    
    Returns:
    
    A fluent helper to fetch multiple PurCtrPartners 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.
  - getPurCtrPartnersByKey
```
@Nonnull
public PurCtrPartnersByKeyFluentHelper getPurCtrPartnersByKey(String purchaseContract,
                                                                       String purchaseContractItem,
                                                                       String purchasingOrganization,
                                                                       String partnerFunction,
                                                                       String plant,
                                                                       String supplierSubrange,
                                                                       String partnerCounter)
```
    Description copied from interface: PurchaseContractService
    
    Fetch a single PurCtrPartners entity using key fields.
    
    Specified by:
    
    getPurCtrPartnersByKey in interface PurchaseContractService
    
    Parameters:
    
    purchaseContract - Alphanumeric key uniquely identifying the document.
    Constraints: Not nullable, Maximum length: 10
    
    purchaseContractItem - Specifies the number that uniquely identifies an item in .
    Constraints: Not nullable, Maximum length: 5
    
    purchasingOrganization - Denotes the purchasing organization.
    Constraints: Not nullable, Maximum length: 4
    
    partnerFunction - The abbreviated form of the name that identifies the partner function.
    Constraints: Not nullable, Maximum length: 2
    
    plant - Key uniquely identifying a plant.
    Constraints: Not nullable, Maximum length: 4
    
    supplierSubrange - Subdivision of a supplier's overall product range according to various criteria.
    Constraints: Not nullable, Maximum length: 6
    
    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
    
    Returns:
    
    A fluent helper to fetch a single PurCtrPartners 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.

Class DefaultPurchaseContractService

Details:

Field Summary

Fields inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.PurchaseContractService

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultPurchaseContractService

Method Detail

withServicePath

batch

getAllPurchaseContract

getPurchaseContractByKey

createPurchaseContract

getAllPurchaseContractItem

getPurchaseContractItemByKey

createPurchaseContractItem

getAllPurContrItemCondition

getPurContrItemConditionByKey

createPurContrItemCondition

updatePurContrItemCondition

getAllPurCtrAccount

getPurCtrAccountByKey

getAllPurCtrAddress

getPurCtrAddressByKey

getAllPurCtrPartners

getPurCtrPartnersByKey