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

Interface CustomerMaterialService

All Superinterfaces:

BatchService<CustomerMaterialServiceBatch>

All Known Implementing Classes:

DefaultCustomerMaterialService

public interface CustomerMaterialService
extends BatchService<CustomerMaterialServiceBatch>

The service contains one entity only for customer material. If there are any issues when the customer material is created, read, updated, or deleted, the system displays error messages in the response..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	OP_API_CUSTOMER_MATERIAL_SRV_0001
API Version:	1
Minimum ERP Version:	2020
Authentication Methods:	Basic, x509
Business Object:	Customer Material

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
CustomerMaterialCreateFluentHelper	createCustomerMaterial(CustomerMaterial customerMaterial) Create a new CustomerMaterial entity and save it to the S/4HANA system.
CustomerMaterialDeleteFluentHelper	deleteCustomerMaterial(CustomerMaterial customerMaterial) Deletes an existing CustomerMaterial entity in the S/4HANA system.
CustomerMaterialFluentHelper	getAllCustomerMaterial() Fetch multiple CustomerMaterial entities.
CustomerMaterialByKeyFluentHelper	getCustomerMaterialByKey(String salesOrganization, String distributionChannel, String customer, String material) Fetch a single CustomerMaterial entity using key fields.
CustomerMaterialUpdateFluentHelper	updateCustomerMaterial(CustomerMaterial customerMaterial) Update an existing CustomerMaterial entity and save it to the S/4HANA system.
CustomerMaterialService	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
CustomerMaterialService 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.

getAllCustomerMaterial

@Nonnull
CustomerMaterialFluentHelper getAllCustomerMaterial()

Fetch multiple CustomerMaterial entities.

Returns:

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

getCustomerMaterialByKey

@Nonnull
CustomerMaterialByKeyFluentHelper getCustomerMaterialByKey(String salesOrganization,
                                                                    String distributionChannel,
                                                                    String customer,
                                                                    String material)

Fetch a single CustomerMaterial entity using key fields.

Parameters:

material - Material Number

Constraints: Not nullable, Maximum length: 40

distributionChannel - Distribution Channel

Constraints: Not nullable, Maximum length: 2

salesOrganization - Sales Organization

Constraints: Not nullable, Maximum length: 4

customer - Customer number

Constraints: Not nullable, Maximum length: 10

Returns:

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

createCustomerMaterial

@Nonnull
CustomerMaterialCreateFluentHelper createCustomerMaterial(@Nonnull
                                                                   CustomerMaterial customerMaterial)

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

Parameters:

customerMaterial - CustomerMaterial entity object that will be created in the S/4HANA system.

Returns:

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

updateCustomerMaterial

@Nonnull
CustomerMaterialUpdateFluentHelper updateCustomerMaterial(@Nonnull
                                                                   CustomerMaterial customerMaterial)

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

Parameters:

customerMaterial - CustomerMaterial entity object that will be updated in the S/4HANA system.

Returns:

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

deleteCustomerMaterial

@Nonnull
CustomerMaterialDeleteFluentHelper deleteCustomerMaterial(@Nonnull
                                                                   CustomerMaterial customerMaterial)

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

Parameters:

customerMaterial - CustomerMaterial entity object that will be deleted in the S/4HANA system.

Returns:

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