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

Interface LeadService

All Superinterfaces:

BatchService<LeadServiceBatch>

All Known Implementing Classes:

DefaultLeadService

public interface LeadService
extends BatchService<LeadServiceBatch>

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

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
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.
LeadService	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
LeadService 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.

getAllLead

@Nonnull
LeadFluentHelper getAllLead()

Fetch multiple Lead entities.

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
LeadByKeyFluentHelper getLeadByKey(String lead)

Fetch a single Lead entity using key fields.

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
LeadCreateFluentHelper createLead(@Nonnull
                                           Lead lead)

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

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
LeadUpdateFluentHelper updateLead(@Nonnull
                                           Lead lead)

Update an existing Lead entity and save it to the S/4HANA system.

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
LeadItemFluentHelper getAllLeadItem()

Fetch multiple LeadItem entities.

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
LeadItemByKeyFluentHelper getLeadItemByKey(String lead,
                                                    String leadItem)

Fetch a single LeadItem entity using key fields.

Parameters:

leadItem - Shortened Item Number in Document

Constraints: Not nullable, Maximum length: 6

lead - Transaction ID

Constraints: Not nullable, Maximum length: 10

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
LeadItemCreateFluentHelper createLeadItem(@Nonnull
                                                   LeadItem leadItem)

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

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
LeadItemUpdateFluentHelper updateLeadItem(@Nonnull
                                                   LeadItem leadItem)

Update an existing LeadItem entity and save it to the S/4HANA system.

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
LeadItemDeleteFluentHelper deleteLeadItem(@Nonnull
                                                   LeadItem leadItem)

Deletes an existing LeadItem entity in the S/4HANA system.

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
LeadPersonRespFluentHelper getAllLeadPersonResp()

Fetch multiple LeadPersonResp entities.

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
LeadPersonRespByKeyFluentHelper getLeadPersonRespByKey(String lead,
                                                                String responsibleEmployee)

Fetch a single LeadPersonResp entity using key fields.

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
LeadPersonRespCreateFluentHelper createLeadPersonResp(@Nonnull
                                                               LeadPersonResp leadPersonResp)

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

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
LeadPersonRespUpdateFluentHelper updateLeadPersonResp(@Nonnull
                                                               LeadPersonResp leadPersonResp)

Update an existing LeadPersonResp entity and save it to the S/4HANA system.

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
LeadPersonRespDeleteFluentHelper deleteLeadPersonResp(@Nonnull
                                                               LeadPersonResp leadPersonResp)

Deletes an existing LeadPersonResp entity in the S/4HANA system.

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
LeadTextFluentHelper getAllLeadText()

Fetch multiple LeadText entities.

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
LeadTextByKeyFluentHelper getLeadTextByKey(String lead,
                                                    String textObjectType,
                                                    String language)

Fetch a single LeadText entity using key fields.

Parameters:

textObjectType - Text ID

Constraints: Not nullable, Maximum length: 4

language - Language Key

Constraints: Not nullable, Maximum length: 2

lead - Transaction ID

Constraints: Not nullable, Maximum length: 10

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
LeadTextCreateFluentHelper createLeadText(@Nonnull
                                                   LeadText leadText)

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

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
LeadTextUpdateFluentHelper updateLeadText(@Nonnull
                                                   LeadText leadText)

Update an existing LeadText entity and save it to the S/4HANA system.

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
LeadTextDeleteFluentHelper deleteLeadText(@Nonnull
                                                   LeadText leadText)

Deletes an existing LeadText entity in the S/4HANA system.

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.