DefaultLeadService (SAP Cloud SDK - Parent POM 3.39.0 API)

java.lang.Object
- com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odata.services.DefaultLeadService

All Implemented Interfaces:

BatchService<LeadServiceBatch>, LeadService
```
@Named(value="com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odata.services.DefaultLeadService")
public class DefaultLeadService
extends Object
implements LeadService
```
The service contains header, item, person responsible, and text entities. The information is sent in the request as a payload. All information is used when creating, updating or deleting a lead data, including appropriate checks for restricted values and authorizations. Once the lead has been created or updated, the lead information is sent in the response. If there are any issues when the lead is created or updated, the system returns error messages. In each API call, you can use the following operations: - Retrieve leads. - Create leads. Note: You must use “deep insert” requests (a header plus the following entities: person responsible, text, and item). - Create new item, person responsible, text for existing leads. - Update the header, person responsible, text, and item for existing leads. - Delete the person responsible, text, and item for existing leads. .

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service: OP_API_LEAD_SRV_0001

API Version: 1

Minimum ERP Version: 2020

Authentication Methods: Basic, x509

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

Constructor Summary

Constructors
Constructor and Description

DefaultLeadService()
Creates a service using LeadService.DEFAULT_SERVICE_PATH to send the requests.

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DefaultLeadServiceBatch`	`batch()` Instantiate a new FluentHelper instance for a single OData batch request.
`LeadCreateFluentHelper`	`createLead(Lead lead)` Create a new `Lead` entity and save it to the S/4HANA system.
`LeadItemCreateFluentHelper`	`createLeadItem(LeadItem leadItem)` Create a new `LeadItem` entity and save it to the S/4HANA system.
`LeadPersonRespCreateFluentHelper`	`createLeadPersonResp(LeadPersonResp leadPersonResp)` Create a new `LeadPersonResp` entity and save it to the S/4HANA system.
`LeadTextCreateFluentHelper`	`createLeadText(LeadText leadText)` Create a new `LeadText` entity and save it to the S/4HANA system.
`LeadItemDeleteFluentHelper`	`deleteLeadItem(LeadItem leadItem)` Deletes an existing `LeadItem` entity in the S/4HANA system.
`LeadPersonRespDeleteFluentHelper`	`deleteLeadPersonResp(LeadPersonResp leadPersonResp)` Deletes an existing `LeadPersonResp` entity in the S/4HANA system.
`LeadTextDeleteFluentHelper`	`deleteLeadText(LeadText leadText)` Deletes an existing `LeadText` entity in the S/4HANA system.
`LeadFluentHelper`	`getAllLead()` Fetch multiple `Lead` entities.
`LeadItemFluentHelper`	`getAllLeadItem()` Fetch multiple `LeadItem` entities.
`LeadPersonRespFluentHelper`	`getAllLeadPersonResp()` Fetch multiple `LeadPersonResp` entities.
`LeadTextFluentHelper`	`getAllLeadText()` Fetch multiple `LeadText` entities.
`LeadByKeyFluentHelper`	`getLeadByKey(String lead)` Fetch a single `Lead` entity using key fields.
`LeadItemByKeyFluentHelper`	`getLeadItemByKey(String lead, String leadItem)` Fetch a single `LeadItem` entity using key fields.
`LeadPersonRespByKeyFluentHelper`	`getLeadPersonRespByKey(String lead, String responsibleEmployee)` Fetch a single `LeadPersonResp` entity using key fields.
`LeadTextByKeyFluentHelper`	`getLeadTextByKey(String lead, String textObjectType, String language)` Fetch a single `LeadText` entity using key fields.
`LeadUpdateFluentHelper`	`updateLead(Lead lead)` Update an existing `Lead` entity and save it to the S/4HANA system.
`LeadItemUpdateFluentHelper`	`updateLeadItem(LeadItem leadItem)` Update an existing `LeadItem` entity and save it to the S/4HANA system.
`LeadPersonRespUpdateFluentHelper`	`updateLeadPersonResp(LeadPersonResp leadPersonResp)` Update an existing `LeadPersonResp` entity and save it to the S/4HANA system.
`LeadTextUpdateFluentHelper`	`updateLeadText(LeadText leadText)` Update an existing `LeadText` entity and save it to the S/4HANA system.
`DefaultLeadService`	`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
  - DefaultLeadService
```
public DefaultLeadService()
```
    Creates a service using LeadService.DEFAULT_SERVICE_PATH to send the requests.
- Method Detail
  - withServicePath
```
@Nonnull
public DefaultLeadService withServicePath(@Nonnull
                                                   String servicePath)
```
    Description copied from interface: LeadService
    
    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 LeadService
    
    Parameters:
    
    servicePath - Service path that will override the default.
    
    Returns:
    
    A new service instance with the specified service path.
  - batch
```
@Nonnull
public DefaultLeadServiceBatch batch()
```
    Instantiate a new FluentHelper instance for a single OData batch request.
    
    Specified by:
    
    batch in interface BatchService<LeadServiceBatch>
    
    Returns:
    
    A new instance of an OData batch request associated with the service object.
  - getAllLead
```
@Nonnull
public LeadFluentHelper getAllLead()
```
    Description copied from interface: LeadService
    
    Fetch multiple Lead entities.
    
    Specified by:
    
    getAllLead in interface LeadService
    
    Returns:
    
    A fluent helper to fetch multiple Lead 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.
  - getLeadByKey
```
@Nonnull
public LeadByKeyFluentHelper getLeadByKey(String lead)
```
    Description copied from interface: LeadService
    
    Fetch a single Lead entity using key fields.
    
    Specified by:
    
    getLeadByKey in interface LeadService
    
    Parameters:
    
    lead - Transaction ID
    Constraints: Not nullable, Maximum length: 10
    
    Returns:
    
    A fluent helper to fetch a single Lead 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.
  - createLead
```
@Nonnull
public LeadCreateFluentHelper createLead(@Nonnull
                                                  Lead lead)
```
    Description copied from interface: LeadService
    
    Create a new Lead entity and save it to the S/4HANA system.
    
    Specified by:
    
    createLead in interface LeadService
    
    Parameters:
    
    lead - Lead entity object that will be created in the S/4HANA system.
    
    Returns:
    
    A fluent helper to create a new Lead entity. To perform execution, call the execute method on the fluent helper object.
  - updateLead
```
@Nonnull
public LeadUpdateFluentHelper updateLead(@Nonnull
                                                  Lead lead)
```
    Description copied from interface: LeadService
    
    Update an existing Lead entity and save it to the S/4HANA system.
    
    Specified by:
    
    updateLead in interface LeadService
    
    Parameters:
    
    lead - Lead entity object that will be updated in the S/4HANA system.
    
    Returns:
    
    A fluent helper to update an existing Lead entity. To perform execution, call the execute method on the fluent helper object.
  - getAllLeadItem
```
@Nonnull
public LeadItemFluentHelper getAllLeadItem()
```
    Description copied from interface: LeadService
    
    Fetch multiple LeadItem entities.
    
    Specified by:
    
    getAllLeadItem in interface LeadService
    
    Returns:
    
    A fluent helper to fetch multiple LeadItem 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.
  - getLeadItemByKey
```
@Nonnull
public LeadItemByKeyFluentHelper getLeadItemByKey(String lead,
                                                           String leadItem)
```
    Description copied from interface: LeadService
    
    Fetch a single LeadItem entity using key fields.
    
    Specified by:
    
    getLeadItemByKey in interface LeadService
    
    Parameters:
    
    lead - Transaction ID
    Constraints: Not nullable, Maximum length: 10
    
    leadItem - Shortened Item Number in Document
    Constraints: Not nullable, Maximum length: 6
    
    Returns:
    
    A fluent helper to fetch a single LeadItem 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.
  - createLeadItem
```
@Nonnull
public LeadItemCreateFluentHelper createLeadItem(@Nonnull
                                                          LeadItem leadItem)
```
    Description copied from interface: LeadService
    
    Create a new LeadItem entity and save it to the S/4HANA system.
    
    Specified by:
    
    createLeadItem in interface LeadService
    
    Parameters:
    
    leadItem - LeadItem entity object that will be created in the S/4HANA system.
    
    Returns:
    
    A fluent helper to create a new LeadItem entity. To perform execution, call the execute method on the fluent helper object.
  - updateLeadItem
```
@Nonnull
public LeadItemUpdateFluentHelper updateLeadItem(@Nonnull
                                                          LeadItem leadItem)
```
    Description copied from interface: LeadService
    
    Update an existing LeadItem entity and save it to the S/4HANA system.
    
    Specified by:
    
    updateLeadItem in interface LeadService
    
    Parameters:
    
    leadItem - LeadItem entity object that will be updated in the S/4HANA system.
    
    Returns:
    
    A fluent helper to update an existing LeadItem entity. To perform execution, call the execute method on the fluent helper object.
  - deleteLeadItem
```
@Nonnull
public LeadItemDeleteFluentHelper deleteLeadItem(@Nonnull
                                                          LeadItem leadItem)
```
    Description copied from interface: LeadService
    
    Deletes an existing LeadItem entity in the S/4HANA system.
    
    Specified by:
    
    deleteLeadItem in interface LeadService
    
    Parameters:
    
    leadItem - LeadItem entity object that will be deleted in the S/4HANA system.
    
    Returns:
    
    A fluent helper to delete an existing LeadItem entity. To perform execution, call the execute method on the fluent helper object.
  - getAllLeadPersonResp
```
@Nonnull
public LeadPersonRespFluentHelper getAllLeadPersonResp()
```
    Description copied from interface: LeadService
    
    Fetch multiple LeadPersonResp entities.
    
    Specified by:
    
    getAllLeadPersonResp in interface LeadService
    
    Returns:
    
    A fluent helper to fetch multiple LeadPersonResp 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.
  - getLeadPersonRespByKey
```
@Nonnull
public LeadPersonRespByKeyFluentHelper getLeadPersonRespByKey(String lead,
                                                                       String responsibleEmployee)
```
    Description copied from interface: LeadService
    
    Fetch a single LeadPersonResp entity using key fields.
    
    Specified by:
    
    getLeadPersonRespByKey in interface LeadService
    
    Parameters:
    
    lead - Transaction ID
    Constraints: Not nullable, Maximum length: 10
    
    responsibleEmployee - Business Partner Number
    Constraints: Not nullable, Maximum length: 10
    
    Returns:
    
    A fluent helper to fetch a single LeadPersonResp 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.
  - createLeadPersonResp
```
@Nonnull
public LeadPersonRespCreateFluentHelper createLeadPersonResp(@Nonnull
                                                                      LeadPersonResp leadPersonResp)
```
    Description copied from interface: LeadService
    
    Create a new LeadPersonResp entity and save it to the S/4HANA system.
    
    Specified by:
    
    createLeadPersonResp in interface LeadService
    
    Parameters:
    
    leadPersonResp - LeadPersonResp entity object that will be created in the S/4HANA system.
    
    Returns:
    
    A fluent helper to create a new LeadPersonResp entity. To perform execution, call the execute method on the fluent helper object.
  - updateLeadPersonResp
```
@Nonnull
public LeadPersonRespUpdateFluentHelper updateLeadPersonResp(@Nonnull
                                                                      LeadPersonResp leadPersonResp)
```
    Description copied from interface: LeadService
    
    Update an existing LeadPersonResp entity and save it to the S/4HANA system.
    
    Specified by:
    
    updateLeadPersonResp in interface LeadService
    
    Parameters:
    
    leadPersonResp - LeadPersonResp entity object that will be updated in the S/4HANA system.
    
    Returns:
    
    A fluent helper to update an existing LeadPersonResp entity. To perform execution, call the execute method on the fluent helper object.
  - deleteLeadPersonResp
```
@Nonnull
public LeadPersonRespDeleteFluentHelper deleteLeadPersonResp(@Nonnull
                                                                      LeadPersonResp leadPersonResp)
```
    Description copied from interface: LeadService
    
    Deletes an existing LeadPersonResp entity in the S/4HANA system.
    
    Specified by:
    
    deleteLeadPersonResp in interface LeadService
    
    Parameters:
    
    leadPersonResp - LeadPersonResp entity object that will be deleted in the S/4HANA system.
    
    Returns:
    
    A fluent helper to delete an existing LeadPersonResp entity. To perform execution, call the execute method on the fluent helper object.
  - getAllLeadText
```
@Nonnull
public LeadTextFluentHelper getAllLeadText()
```
    Description copied from interface: LeadService
    
    Fetch multiple LeadText entities.
    
    Specified by:
    
    getAllLeadText in interface LeadService
    
    Returns:
    
    A fluent helper to fetch multiple LeadText 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.
  - getLeadTextByKey
```
@Nonnull
public LeadTextByKeyFluentHelper getLeadTextByKey(String lead,
                                                           String textObjectType,
                                                           String language)
```
    Description copied from interface: LeadService
    
    Fetch a single LeadText entity using key fields.
    
    Specified by:
    
    getLeadTextByKey in interface LeadService
    
    Parameters:
    
    lead - Transaction ID
    Constraints: Not nullable, Maximum length: 10
    
    textObjectType - Text ID
    Constraints: Not nullable, Maximum length: 4
    
    language - Language Key
    Constraints: Not nullable, Maximum length: 2
    
    Returns:
    
    A fluent helper to fetch a single LeadText 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.
  - createLeadText
```
@Nonnull
public LeadTextCreateFluentHelper createLeadText(@Nonnull
                                                          LeadText leadText)
```
    Description copied from interface: LeadService
    
    Create a new LeadText entity and save it to the S/4HANA system.
    
    Specified by:
    
    createLeadText in interface LeadService
    
    Parameters:
    
    leadText - LeadText entity object that will be created in the S/4HANA system.
    
    Returns:
    
    A fluent helper to create a new LeadText entity. To perform execution, call the execute method on the fluent helper object.
  - updateLeadText
```
@Nonnull
public LeadTextUpdateFluentHelper updateLeadText(@Nonnull
                                                          LeadText leadText)
```
    Description copied from interface: LeadService
    
    Update an existing LeadText entity and save it to the S/4HANA system.
    
    Specified by:
    
    updateLeadText in interface LeadService
    
    Parameters:
    
    leadText - LeadText entity object that will be updated in the S/4HANA system.
    
    Returns:
    
    A fluent helper to update an existing LeadText entity. To perform execution, call the execute method on the fluent helper object.
  - deleteLeadText
```
@Nonnull
public LeadTextDeleteFluentHelper deleteLeadText(@Nonnull
                                                          LeadText leadText)
```
    Description copied from interface: LeadService
    
    Deletes an existing LeadText entity in the S/4HANA system.
    
    Specified by:
    
    deleteLeadText in interface LeadService
    
    Parameters:
    
    leadText - LeadText entity object that will be deleted in the S/4HANA system.
    
    Returns:
    
    A fluent helper to delete an existing LeadText entity. To perform execution, call the execute method on the fluent helper object.

OData Service:	OP_API_LEAD_SRV_0001
API Version:	1
Minimum ERP Version:	2020
Authentication Methods:	Basic, x509

Class DefaultLeadService

Details:

Field Summary

Fields inherited from interface com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odata.services.LeadService

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultLeadService

Method Detail

withServicePath

batch

getAllLead

getLeadByKey

createLead

updateLead

getAllLeadItem

getLeadItemByKey

createLeadItem

updateLeadItem

deleteLeadItem

getAllLeadPersonResp

getLeadPersonRespByKey

createLeadPersonResp

updateLeadPersonResp

deleteLeadPersonResp

getAllLeadText

getLeadTextByKey

createLeadText

updateLeadText

deleteLeadText