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

Class DefaultLegalDocumentStatusService

java.lang.Object

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

All Implemented Interfaces:

BatchService<LegalDocumentStatusServiceBatch>, LegalDocumentStatusService

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

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:	OP_API_LEGALDOCUMENTSTATUS_0001
API Version:	1
Minimum ERP Version:	2020
Authentication Methods:	Basic, x509
Business Object:	Legal Document Status

Field Summary

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

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultLegalDocumentStatusService() Creates a service using LegalDocumentStatusService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
DefaultLegalDocumentStatusServiceBatch	batch() Instantiate a new FluentHelper instance for a single OData batch request.
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.
DefaultLegalDocumentStatusService	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

DefaultLegalDocumentStatusService

public DefaultLegalDocumentStatusService()

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

Method Detail

withServicePath

@Nonnull
public DefaultLegalDocumentStatusService withServicePath(@Nonnull
                                                                  String servicePath)

Description copied from interface: LegalDocumentStatusService

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 LegalDocumentStatusService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultLegalDocumentStatusServiceBatch batch()

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

Specified by:

batch in interface BatchService<LegalDocumentStatusServiceBatch>

Returns:

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

getAllLegalDocumentStatus

@Nonnull
public LegalDocumentStatusFluentHelper getAllLegalDocumentStatus()

Description copied from interface: LegalDocumentStatusService

Fetch multiple LegalDocumentStatus entities.

Specified by:

getAllLegalDocumentStatus in interface LegalDocumentStatusService

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
public LegalDocumentStatusByKeyFluentHelper getLegalDocumentStatusByKey(String internalDocumentStatus)

Description copied from interface: LegalDocumentStatusService

Fetch a single LegalDocumentStatus entity using key fields.

Specified by:

getLegalDocumentStatusByKey in interface LegalDocumentStatusService

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
public LegalDocumentStatusTextFluentHelper getAllLegalDocumentStatusText()

Description copied from interface: LegalDocumentStatusService

Fetch multiple LegalDocumentStatusText entities.

Specified by:

getAllLegalDocumentStatusText in interface LegalDocumentStatusService

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
public LegalDocumentStatusTextByKeyFluentHelper getLegalDocumentStatusTextByKey(String internalDocumentStatus,
                                                                                         String language)

Description copied from interface: LegalDocumentStatusService

Fetch a single LegalDocumentStatusText entity using key fields.

Specified by:

getLegalDocumentStatusTextByKey in interface LegalDocumentStatusService

Parameters:

internalDocumentStatus - Document Status

Constraints: Not nullable, Maximum length: 2

language - Language Key

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.