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

Class DefaultLegalCategorieService

java.lang.Object

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

All Implemented Interfaces:

BatchService<LegalCategorieServiceBatch>, LegalCategorieService

@Named(value="com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odata.services.DefaultLegalCategorieService")
public class DefaultLegalCategorieService
extends Object
implements LegalCategorieService

This synchronous inbound service is based on the OData protocol and helps you to read legal categories through an API call. Category is one of the objects used to categorize Contexts, Legal Transactions, Templates and Text Blocks. This service contains legal categories and legal category text nodes. Using this service, you can read the legal categories created in the Categories application..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	OP_API_LEGAL_CATEGORY_SRV_0001
API Version:	1
Minimum ERP Version:	2020
Authentication Methods:	Basic, x509
Business Object:	Legal Category

Field Summary

Fields inherited from interface com.sap.cloud.sdk.s4hana.onpremise.v2020.datamodel.odata.services.LegalCategorieService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultLegalCategorieService() Creates a service using LegalCategorieService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
DefaultLegalCategorieServiceBatch	batch() Instantiate a new FluentHelper instance for a single OData batch request.
LegalCategoryFluentHelper	getAllLegalCategory() Fetch multiple LegalCategory entities.
LegalCategoryTextFluentHelper	getAllLegalCategoryText() Fetch multiple LegalCategoryText entities.
LegalCategoryByKeyFluentHelper	getLegalCategoryByKey(String lglCntntMCategory) Fetch a single LegalCategory entity using key fields.
LegalCategoryTextByKeyFluentHelper	getLegalCategoryTextByKey(String lglCntntMCategory, String language) Fetch a single LegalCategoryText entity using key fields.
DefaultLegalCategorieService	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

DefaultLegalCategorieService

public DefaultLegalCategorieService()

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

Method Detail

withServicePath

@Nonnull
public DefaultLegalCategorieService withServicePath(@Nonnull
                                                             String servicePath)

Description copied from interface: LegalCategorieService

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 LegalCategorieService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultLegalCategorieServiceBatch batch()

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

Specified by:

batch in interface BatchService<LegalCategorieServiceBatch>

Returns:

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

getAllLegalCategory

@Nonnull
public LegalCategoryFluentHelper getAllLegalCategory()

Description copied from interface: LegalCategorieService

Fetch multiple LegalCategory entities.

Specified by:

getAllLegalCategory in interface LegalCategorieService

Returns:

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

getLegalCategoryByKey

@Nonnull
public LegalCategoryByKeyFluentHelper getLegalCategoryByKey(String lglCntntMCategory)

Description copied from interface: LegalCategorieService

Fetch a single LegalCategory entity using key fields.

Specified by:

getLegalCategoryByKey in interface LegalCategorieService

Parameters:

lglCntntMCategory - Category ID

Constraints: Not nullable, Maximum length: 6

Returns:

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

getAllLegalCategoryText

@Nonnull
public LegalCategoryTextFluentHelper getAllLegalCategoryText()

Description copied from interface: LegalCategorieService

Fetch multiple LegalCategoryText entities.

Specified by:

getAllLegalCategoryText in interface LegalCategorieService

Returns:

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

getLegalCategoryTextByKey

@Nonnull
public LegalCategoryTextByKeyFluentHelper getLegalCategoryTextByKey(String lglCntntMCategory,
                                                                             String language)

Description copied from interface: LegalCategorieService

Fetch a single LegalCategoryText entity using key fields.

Specified by:

getLegalCategoryTextByKey in interface LegalCategorieService

Parameters:

lglCntntMCategory - Category ID

Constraints: Not nullable, Maximum length: 6

language - Language Key

Constraints: Not nullable, Maximum length: 2

Returns:

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