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

Class DefaultCompanyCodeService

java.lang.Object

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

All Implemented Interfaces:

BatchService<CompanyCodeServiceBatch>, CompanyCodeService

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

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 inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.CompanyCodeService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultCompanyCodeService() Creates a service using CompanyCodeService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
DefaultCompanyCodeServiceBatch	batch() Instantiate a new FluentHelper instance for a single OData batch request.
CompanyCodeFluentHelper	getAllCompanyCode() Fetch multiple CompanyCode entities.
CompanyCodeByKeyFluentHelper	getCompanyCodeByKey(String companyCode) Fetch a single CompanyCode entity using key fields.
DefaultCompanyCodeService	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

DefaultCompanyCodeService

public DefaultCompanyCodeService()

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

Method Detail

withServicePath

@Nonnull
public DefaultCompanyCodeService withServicePath(@Nonnull
                                                           String servicePath)

Description copied from interface: CompanyCodeService

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 CompanyCodeService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultCompanyCodeServiceBatch batch()

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

Specified by:

batch in interface BatchService<CompanyCodeServiceBatch>

Returns:

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

getAllCompanyCode

@Nonnull
public CompanyCodeFluentHelper getAllCompanyCode()

Description copied from interface: CompanyCodeService

Fetch multiple CompanyCode entities.

Specified by:

getAllCompanyCode in interface CompanyCodeService

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
public CompanyCodeByKeyFluentHelper getCompanyCodeByKey(String companyCode)

Description copied from interface: CompanyCodeService

Fetch a single CompanyCode entity using key fields.

Specified by:

getCompanyCodeByKey in interface CompanyCodeService

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.