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

Class DefaultTradingPartnerService

java.lang.Object

com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultTradingPartnerService

All Implemented Interfaces:

BatchService<TradingPartnerServiceBatch>, TradingPartnerService

@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultTradingPartnerService")
public class DefaultTradingPartnerService
extends Object
implements TradingPartnerService

This service enables you to read trading partner master data in an API call. It is based on the OData protocol, and can be consumed in Fiori apps and on other user interfaces.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_PARTNERCOMPANY_SRV
API Version:	1
Communication Scenario:	SAP Business Objects Cloud for Planning Integration (SAP_COM_0087)
Scope Items:	oData Integration with SAP Business Objects Cloud for Planning (1YB)

Field Summary

Fields inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.TradingPartnerService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultTradingPartnerService() Creates a service using TradingPartnerService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
DefaultTradingPartnerServiceBatch	batch() Instantiate a new FluentHelper instance for a single OData batch request.
PartnerCompanyFluentHelper	getAllPartnerCompany() Fetch multiple PartnerCompany entities.
PartnerCompanyByKeyFluentHelper	getPartnerCompanyByKey(String partnerCompany) Fetch a single PartnerCompany entity using key fields.
DefaultTradingPartnerService	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

DefaultTradingPartnerService

public DefaultTradingPartnerService()

Creates a service using TradingPartnerService.DEFAULT_SERVICE_PATH to send the requests.

Method Detail

withServicePath

@Nonnull
public DefaultTradingPartnerService withServicePath(@Nonnull
                                                             String servicePath)

Description copied from interface: TradingPartnerService

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 TradingPartnerService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultTradingPartnerServiceBatch batch()

Instantiate a new FluentHelper instance for a single OData batch request.

Specified by:

batch in interface BatchService<TradingPartnerServiceBatch>

Returns:

A new instance of an OData batch request associated with the service object.

getAllPartnerCompany

@Nonnull
public PartnerCompanyFluentHelper getAllPartnerCompany()

Description copied from interface: TradingPartnerService

Fetch multiple PartnerCompany entities.

Specified by:

getAllPartnerCompany in interface TradingPartnerService

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
public PartnerCompanyByKeyFluentHelper getPartnerCompanyByKey(String partnerCompany)

Description copied from interface: TradingPartnerService

Fetch a single PartnerCompany entity using key fields.

Specified by:

getPartnerCompanyByKey in interface TradingPartnerService

Parameters:

partnerCompany - Unique company ID of a company within your corporate group.

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.