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

Interface TradingPartnerService

All Superinterfaces:

BatchService<TradingPartnerServiceBatch>

All Known Implementing Classes:

DefaultTradingPartnerService

public interface TradingPartnerService
extends BatchService<TradingPartnerServiceBatch>

The service enables you to retrieve trading partner master data. It contains a header and nodes with business information. You can read trading partners and their texts..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	OP_API_PARTNERCOMPANY_SRV
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
PartnerCompanyFluentHelper	getAllPartnerCompany() Fetch multiple PartnerCompany entities.
PartnerCompanyByKeyFluentHelper	getPartnerCompanyByKey(String partnerCompany) Fetch a single PartnerCompany entity using key fields.
TradingPartnerService	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
TradingPartnerService 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.

getAllPartnerCompany

@Nonnull
PartnerCompanyFluentHelper getAllPartnerCompany()

Fetch multiple PartnerCompany entities.

Returns:

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

getPartnerCompanyByKey

@Nonnull
PartnerCompanyByKeyFluentHelper getPartnerCompanyByKey(String partnerCompany)

Fetch a single PartnerCompany entity using key fields.

Parameters:

partnerCompany - Company

Constraints: Not nullable, Maximum length: 6

Returns:

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