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

Interface LegalDocumentStatusService

All Superinterfaces:

BatchService<LegalDocumentStatusServiceBatch>

All Known Implementing Classes:

DefaultLegalDocumentStatusService

public interface LegalDocumentStatusService
extends BatchService<LegalDocumentStatusServiceBatch>

This synchronous inbound service is based on the OData protocol and helps you to read the possible values of legal document status through an API call. This describes the status of a legal document. For example, 'In Process', 'Accepted' and so on are the various statuses assigned to a legal document. This service contains legal document status and legal document status text nodes. Using this service, you can read the legal document status type maintained in the system..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_LEGALDOCUMENTSTATUS
API Version:	1
Communication Scenario:	Legal Document Integration (SAP_COM_0178)
Scope Items:	SAP S/4HANA for Enterprise Contract Management (1XV)
Authentication Methods:	Basic, x509
Business Object:	LegalDocumentStatus

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
LegalDocumentStatusFluentHelper	getAllLegalDocumentStatus() Fetch multiple LegalDocumentStatus entities.
LegalDocumentStatusTextFluentHelper	getAllLegalDocumentStatusText() Fetch multiple LegalDocumentStatusText entities.
LegalDocumentStatusByKeyFluentHelper	getLegalDocumentStatusByKey(String internalDocumentStatus) Fetch a single LegalDocumentStatus entity using key fields.
LegalDocumentStatusTextByKeyFluentHelper	getLegalDocumentStatusTextByKey(String internalDocumentStatus, String language) Fetch a single LegalDocumentStatusText entity using key fields.
LegalDocumentStatusService	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
LegalDocumentStatusService 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.

getAllLegalDocumentStatus

@Nonnull
LegalDocumentStatusFluentHelper getAllLegalDocumentStatus()

Fetch multiple LegalDocumentStatus entities.

Returns:

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

getLegalDocumentStatusByKey

@Nonnull
LegalDocumentStatusByKeyFluentHelper getLegalDocumentStatusByKey(String internalDocumentStatus)

Fetch a single LegalDocumentStatus entity using key fields.

Parameters:

internalDocumentStatus - Document Status

Constraints: Not nullable, Maximum length: 2

Returns:

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

getAllLegalDocumentStatusText

@Nonnull
LegalDocumentStatusTextFluentHelper getAllLegalDocumentStatusText()

Fetch multiple LegalDocumentStatusText entities.

Returns:

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

getLegalDocumentStatusTextByKey

@Nonnull
LegalDocumentStatusTextByKeyFluentHelper getLegalDocumentStatusTextByKey(String internalDocumentStatus,
                                                                                  String language)

Fetch a single LegalDocumentStatusText entity using key fields.

Parameters:

internalDocumentStatus - Document Status

Constraints: Not nullable, Maximum length: 2

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

Constraints: Not nullable, Maximum length: 2

Returns:

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