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

Interface CompanyCodeService

All Superinterfaces:

BatchService<CompanyCodeServiceBatch>

All Known Implementing Classes:

DefaultCompanyCodeService

public interface CompanyCodeService
extends BatchService<CompanyCodeServiceBatch>

This service enables you to read company code 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_COMPANYCODE_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

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
CompanyCodeFluentHelper	getAllCompanyCode() Fetch multiple CompanyCode entities.
CompanyCodeByKeyFluentHelper	getCompanyCodeByKey(String companyCode) Fetch a single CompanyCode entity using key fields.
CompanyCodeService	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.s4hana.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
CompanyCodeService 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.

getAllCompanyCode

@Nonnull
CompanyCodeFluentHelper getAllCompanyCode()

Fetch multiple CompanyCode entities.

Returns:

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

getCompanyCodeByKey

@Nonnull
CompanyCodeByKeyFluentHelper getCompanyCodeByKey(String companyCode)

Fetch a single CompanyCode entity using key fields.

Parameters:

companyCode - The company code is an organizational unit within financial accounting.

Constraints: Not nullable, Maximum length: 4

Returns:

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