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

Interface LegalDocumentService

All Superinterfaces:

BatchService<LegalDocumentServiceBatch>

All Known Implementing Classes:

DefaultLegalDocumentService

public interface LegalDocumentService
extends BatchService<LegalDocumentServiceBatch>

Legal documents are instances of legal content which are tailored to a specific legal transaction. The service contains legal document and legal document stamp nodes. The information sent in the request as a payload is used when creating a legal document, including appropriate checks for restricted values and authorizations. Once the legal document is created, the legal document ID is sent in the response with the data included in the legal document. If there are any issues when the legal document is created, the system displays error messages in the response. Note that to create or change the content of the legal document you need to use the Attachment Service that is also published in the SAP API Business Hub. For more information, refer to the business documentation of this API..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_LEGAL_DOCUMENT_SRV
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:	LegalDocument

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
LegalDocumentCreateFluentHelper	createLegalDocument(LegalDocument legalDocument) Create a new LegalDocument entity and save it to the S/4HANA system.
LglCntntMDocCategoryCreateFluentHelper	createLglCntntMDocCategory(LglCntntMDocCategory lglCntntMDocCategory) Create a new LglCntntMDocCategory entity and save it to the S/4HANA system.
LglCntntMDocParCategoryCreateFluentHelper	createLglCntntMDocParCategory(LglCntntMDocParCategory lglCntntMDocParCategory) Create a new LglCntntMDocParCategory entity and save it to the S/4HANA system.
LglDocStampCreateFluentHelper	createLglDocStamp(LglDocStamp lglDocStamp) Create a new LglDocStamp entity and save it to the S/4HANA system.
LegalDocumentFluentHelper	getAllLegalDocument() Fetch multiple LegalDocument entities.
LglCntntMDocCategoryFluentHelper	getAllLglCntntMDocCategory() Fetch multiple LglCntntMDocCategory entities.
LglCntntMDocParCategoryFluentHelper	getAllLglCntntMDocParCategory() Fetch multiple LglCntntMDocParCategory entities.
LglDocStampFluentHelper	getAllLglDocStamp() Fetch multiple LglDocStamp entities.
LegalDocumentByKeyFluentHelper	getLegalDocumentByKey(UUID lglCntntMDocumentUUID) Fetch a single LegalDocument entity using key fields.
LglCntntMDocCategoryByKeyFluentHelper	getLglCntntMDocCategoryByKey(UUID lglCntntMDocCategoryUUID) Fetch a single LglCntntMDocCategory entity using key fields.
LglCntntMDocParCategoryByKeyFluentHelper	getLglCntntMDocParCategoryByKey(UUID lglCntntMDocParCatUUID) Fetch a single LglCntntMDocParCategory entity using key fields.
LglDocStampByKeyFluentHelper	getLglDocStampByKey(UUID lglCntntMDocumentStampUUID) Fetch a single LglDocStamp entity using key fields.
LegalDocumentService	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
LegalDocumentService 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.

getAllLegalDocument

@Nonnull
LegalDocumentFluentHelper getAllLegalDocument()

Fetch multiple LegalDocument entities.

Returns:

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

getLegalDocumentByKey

@Nonnull
LegalDocumentByKeyFluentHelper getLegalDocumentByKey(UUID lglCntntMDocumentUUID)

Fetch a single LegalDocument entity using key fields.

Parameters:

lglCntntMDocumentUUID - Universal Unique Identifier

Constraints: Not nullable

Returns:

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

createLegalDocument

@Nonnull
LegalDocumentCreateFluentHelper createLegalDocument(@Nonnull
                                                             LegalDocument legalDocument)

Create a new LegalDocument entity and save it to the S/4HANA system.

Parameters:

legalDocument - LegalDocument entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new LegalDocument entity. To perform execution, call the execute method on the fluent helper object.

getAllLglCntntMDocCategory

@Nonnull
LglCntntMDocCategoryFluentHelper getAllLglCntntMDocCategory()

Fetch multiple LglCntntMDocCategory entities.

Returns:

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

getLglCntntMDocCategoryByKey

@Nonnull
LglCntntMDocCategoryByKeyFluentHelper getLglCntntMDocCategoryByKey(UUID lglCntntMDocCategoryUUID)

Fetch a single LglCntntMDocCategory entity using key fields.

Parameters:

lglCntntMDocCategoryUUID - Universal Unique Identifier

Constraints: Not nullable

Returns:

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

createLglCntntMDocCategory

@Nonnull
LglCntntMDocCategoryCreateFluentHelper createLglCntntMDocCategory(@Nonnull
                                                                           LglCntntMDocCategory lglCntntMDocCategory)

Create a new LglCntntMDocCategory entity and save it to the S/4HANA system.

Parameters:

lglCntntMDocCategory - LglCntntMDocCategory entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new LglCntntMDocCategory entity. To perform execution, call the execute method on the fluent helper object.

getAllLglCntntMDocParCategory

@Nonnull
LglCntntMDocParCategoryFluentHelper getAllLglCntntMDocParCategory()

Fetch multiple LglCntntMDocParCategory entities.

Returns:

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

getLglCntntMDocParCategoryByKey

@Nonnull
LglCntntMDocParCategoryByKeyFluentHelper getLglCntntMDocParCategoryByKey(UUID lglCntntMDocParCatUUID)

Fetch a single LglCntntMDocParCategory entity using key fields.

Parameters:

lglCntntMDocParCatUUID - Universal Unique Identifier

Constraints: Not nullable

Returns:

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

createLglCntntMDocParCategory

@Nonnull
LglCntntMDocParCategoryCreateFluentHelper createLglCntntMDocParCategory(@Nonnull
                                                                                 LglCntntMDocParCategory lglCntntMDocParCategory)

Create a new LglCntntMDocParCategory entity and save it to the S/4HANA system.

Parameters:

lglCntntMDocParCategory - LglCntntMDocParCategory entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new LglCntntMDocParCategory entity. To perform execution, call the execute method on the fluent helper object.

getAllLglDocStamp

@Nonnull
LglDocStampFluentHelper getAllLglDocStamp()

Fetch multiple LglDocStamp entities.

Returns:

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

getLglDocStampByKey

@Nonnull
LglDocStampByKeyFluentHelper getLglDocStampByKey(UUID lglCntntMDocumentStampUUID)

Fetch a single LglDocStamp entity using key fields.

Parameters:

lglCntntMDocumentStampUUID - Universal Unique Identifier

Constraints: Not nullable

Returns:

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

createLglDocStamp

@Nonnull
LglDocStampCreateFluentHelper createLglDocStamp(@Nonnull
                                                         LglDocStamp lglDocStamp)

Create a new LglDocStamp entity and save it to the S/4HANA system.

Parameters:

lglDocStamp - LglDocStamp entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new LglDocStamp entity. To perform execution, call the execute method on the fluent helper object.