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

Interface TaskActivityService

All Superinterfaces:

BatchService<TaskActivityServiceBatch>

All Known Implementing Classes:

DefaultTaskActivityService

public interface TaskActivityService
extends BatchService<TaskActivityServiceBatch>

The service contains header, 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 task activity data, including appropriate checks for restricted values and authorizations. Once the task activity has been created or updated, the task activity information is sent in the response. If there are any issues when the task activity is created or updated, the system returns error messages. In each API call, you can use the following operations: - Retrieve task activities. - Create task activities. Note: You must use “deep insert” requests (a header plus the following entities: person responsible, and text). - Create new person responsible, text for existing task activities. - Update the header, person responsible, and text for existing task activities. - Delete the person responsible, and text for existing task activities. .

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	OP_API_TASK_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
CustMgmtTaskCreateFluentHelper	createCustMgmtTask(CustMgmtTask custMgmtTask) Create a new CustMgmtTask entity and save it to the S/4HANA system.
CustMgmtTaskPersonRespCreateFluentHelper	createCustMgmtTaskPersonResp(CustMgmtTaskPersonResp custMgmtTaskPersonResp) Create a new CustMgmtTaskPersonResp entity and save it to the S/4HANA system.
CustMgmtTaskTextCreateFluentHelper	createCustMgmtTaskText(CustMgmtTaskText custMgmtTaskText) Create a new CustMgmtTaskText entity and save it to the S/4HANA system.
CustMgmtTaskPersonRespDeleteFluentHelper	deleteCustMgmtTaskPersonResp(CustMgmtTaskPersonResp custMgmtTaskPersonResp) Deletes an existing CustMgmtTaskPersonResp entity in the S/4HANA system.
CustMgmtTaskTextDeleteFluentHelper	deleteCustMgmtTaskText(CustMgmtTaskText custMgmtTaskText) Deletes an existing CustMgmtTaskText entity in the S/4HANA system.
CustMgmtTaskFluentHelper	getAllCustMgmtTask() Fetch multiple CustMgmtTask entities.
CustMgmtTaskPersonRespFluentHelper	getAllCustMgmtTaskPersonResp() Fetch multiple CustMgmtTaskPersonResp entities.
CustMgmtTaskTextFluentHelper	getAllCustMgmtTaskText() Fetch multiple CustMgmtTaskText entities.
CustMgmtTaskByKeyFluentHelper	getCustMgmtTaskByKey(String custMgmtTask) Fetch a single CustMgmtTask entity using key fields.
CustMgmtTaskPersonRespByKeyFluentHelper	getCustMgmtTaskPersonRespByKey(String custMgmtTask, String responsibleEmployee) Fetch a single CustMgmtTaskPersonResp entity using key fields.
CustMgmtTaskTextByKeyFluentHelper	getCustMgmtTaskTextByKey(String custMgmtTask, String textObjectType, String language) Fetch a single CustMgmtTaskText entity using key fields.
CustMgmtTaskUpdateFluentHelper	updateCustMgmtTask(CustMgmtTask custMgmtTask) Update an existing CustMgmtTask entity and save it to the S/4HANA system.
CustMgmtTaskPersonRespUpdateFluentHelper	updateCustMgmtTaskPersonResp(CustMgmtTaskPersonResp custMgmtTaskPersonResp) Update an existing CustMgmtTaskPersonResp entity and save it to the S/4HANA system.
CustMgmtTaskTextUpdateFluentHelper	updateCustMgmtTaskText(CustMgmtTaskText custMgmtTaskText) Update an existing CustMgmtTaskText entity and save it to the S/4HANA system.
TaskActivityService	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
TaskActivityService 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.

getAllCustMgmtTask

@Nonnull
CustMgmtTaskFluentHelper getAllCustMgmtTask()

Fetch multiple CustMgmtTask entities.

Returns:

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

getCustMgmtTaskByKey

@Nonnull
CustMgmtTaskByKeyFluentHelper getCustMgmtTaskByKey(String custMgmtTask)

Fetch a single CustMgmtTask entity using key fields.

Parameters:

custMgmtTask - Transaction ID

Constraints: Not nullable, Maximum length: 10

Returns:

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

createCustMgmtTask

@Nonnull
CustMgmtTaskCreateFluentHelper createCustMgmtTask(@Nonnull
                                                           CustMgmtTask custMgmtTask)

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

Parameters:

custMgmtTask - CustMgmtTask entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new CustMgmtTask entity. To perform execution, call the execute method on the fluent helper object.

updateCustMgmtTask

@Nonnull
CustMgmtTaskUpdateFluentHelper updateCustMgmtTask(@Nonnull
                                                           CustMgmtTask custMgmtTask)

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

Parameters:

custMgmtTask - CustMgmtTask entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing CustMgmtTask entity. To perform execution, call the execute method on the fluent helper object.

getAllCustMgmtTaskPersonResp

@Nonnull
CustMgmtTaskPersonRespFluentHelper getAllCustMgmtTaskPersonResp()

Fetch multiple CustMgmtTaskPersonResp entities.

Returns:

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

getCustMgmtTaskPersonRespByKey

@Nonnull
CustMgmtTaskPersonRespByKeyFluentHelper getCustMgmtTaskPersonRespByKey(String custMgmtTask,
                                                                                String responsibleEmployee)

Fetch a single CustMgmtTaskPersonResp entity using key fields.

Parameters:

custMgmtTask - 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 CustMgmtTaskPersonResp 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.

createCustMgmtTaskPersonResp

@Nonnull
CustMgmtTaskPersonRespCreateFluentHelper createCustMgmtTaskPersonResp(@Nonnull
                                                                               CustMgmtTaskPersonResp custMgmtTaskPersonResp)

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

Parameters:

custMgmtTaskPersonResp - CustMgmtTaskPersonResp entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new CustMgmtTaskPersonResp entity. To perform execution, call the execute method on the fluent helper object.

updateCustMgmtTaskPersonResp

@Nonnull
CustMgmtTaskPersonRespUpdateFluentHelper updateCustMgmtTaskPersonResp(@Nonnull
                                                                               CustMgmtTaskPersonResp custMgmtTaskPersonResp)

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

Parameters:

custMgmtTaskPersonResp - CustMgmtTaskPersonResp entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing CustMgmtTaskPersonResp entity. To perform execution, call the execute method on the fluent helper object.

deleteCustMgmtTaskPersonResp

@Nonnull
CustMgmtTaskPersonRespDeleteFluentHelper deleteCustMgmtTaskPersonResp(@Nonnull
                                                                               CustMgmtTaskPersonResp custMgmtTaskPersonResp)

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

Parameters:

custMgmtTaskPersonResp - CustMgmtTaskPersonResp entity object that will be deleted in the S/4HANA system.

Returns:

A fluent helper to delete an existing CustMgmtTaskPersonResp entity. To perform execution, call the execute method on the fluent helper object.

getAllCustMgmtTaskText

@Nonnull
CustMgmtTaskTextFluentHelper getAllCustMgmtTaskText()

Fetch multiple CustMgmtTaskText entities.

Returns:

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

getCustMgmtTaskTextByKey

@Nonnull
CustMgmtTaskTextByKeyFluentHelper getCustMgmtTaskTextByKey(String custMgmtTask,
                                                                    String textObjectType,
                                                                    String language)

Fetch a single CustMgmtTaskText entity using key fields.

Parameters:

custMgmtTask - 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 CustMgmtTaskText 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.

createCustMgmtTaskText

@Nonnull
CustMgmtTaskTextCreateFluentHelper createCustMgmtTaskText(@Nonnull
                                                                   CustMgmtTaskText custMgmtTaskText)

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

Parameters:

custMgmtTaskText - CustMgmtTaskText entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new CustMgmtTaskText entity. To perform execution, call the execute method on the fluent helper object.

updateCustMgmtTaskText

@Nonnull
CustMgmtTaskTextUpdateFluentHelper updateCustMgmtTaskText(@Nonnull
                                                                   CustMgmtTaskText custMgmtTaskText)

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

Parameters:

custMgmtTaskText - CustMgmtTaskText entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing CustMgmtTaskText entity. To perform execution, call the execute method on the fluent helper object.

deleteCustMgmtTaskText

@Nonnull
CustMgmtTaskTextDeleteFluentHelper deleteCustMgmtTaskText(@Nonnull
                                                                   CustMgmtTaskText custMgmtTaskText)

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

Parameters:

custMgmtTaskText - CustMgmtTaskText entity object that will be deleted in the S/4HANA system.

Returns:

A fluent helper to delete an existing CustMgmtTaskText entity. To perform execution, call the execute method on the fluent helper object.