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

Interface LegalCategorieService

All Superinterfaces:

BatchService<LegalCategorieServiceBatch>

All Known Implementing Classes:

DefaultLegalCategorieService

public interface LegalCategorieService
extends BatchService<LegalCategorieServiceBatch>

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:	API_LEGAL_CATEGORY_SRV
API Version:	1
Communication Scenario:	Enterprise Contract Management and Assembly Integration (SAP_COM_0437)
Scope Items:	Integration to SAP S/4HANA Cloud for Enterprise Contract Assembly (2OQ)
Authentication Methods:	Basic, x509
Business Object:	LegalCategory

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
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.
LegalCategorieService	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
LegalCategorieService 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.

getAllLegalCategory

@Nonnull
LegalCategoryFluentHelper getAllLegalCategory()

Fetch multiple LegalCategory entities.

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
LegalCategoryByKeyFluentHelper getLegalCategoryByKey(String lglCntntMCategory)

Fetch a single LegalCategory entity using key fields.

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
LegalCategoryTextFluentHelper getAllLegalCategoryText()

Fetch multiple LegalCategoryText entities.

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
LegalCategoryTextByKeyFluentHelper getLegalCategoryTextByKey(String lglCntntMCategory,
                                                                      String language)

Fetch a single LegalCategoryText entity using key fields.

Parameters:

language - The Language key field contains an alphanumeric code that identifies the language an entry is written in.

Constraints: Not nullable, Maximum length: 2

lglCntntMCategory - Category ID

Constraints: Not nullable, Maximum length: 6

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.