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

Class DefaultLegalDocumentService

java.lang.Object

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

All Implemented Interfaces:

BatchService<LegalDocumentServiceBatch>, LegalDocumentService

@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultLegalDocumentService")
public class DefaultLegalDocumentService
extends Object
implements LegalDocumentService

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 inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.LegalDocumentService

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultLegalDocumentService() Creates a service using LegalDocumentService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

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

DefaultLegalDocumentService

public DefaultLegalDocumentService()

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

Method Detail

withServicePath

@Nonnull
public DefaultLegalDocumentService withServicePath(@Nonnull
                                                            String servicePath)

Description copied from interface: LegalDocumentService

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 LegalDocumentService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultLegalDocumentServiceBatch batch()

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

Specified by:

batch in interface BatchService<LegalDocumentServiceBatch>

Returns:

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

getAllLegalDocument

@Nonnull
public LegalDocumentFluentHelper getAllLegalDocument()

Description copied from interface: LegalDocumentService

Fetch multiple LegalDocument entities.

Specified by:

getAllLegalDocument in interface LegalDocumentService

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
public LegalDocumentByKeyFluentHelper getLegalDocumentByKey(UUID lglCntntMDocumentUUID)

Description copied from interface: LegalDocumentService

Fetch a single LegalDocument entity using key fields.

Specified by:

getLegalDocumentByKey in interface LegalDocumentService

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
public LegalDocumentCreateFluentHelper createLegalDocument(@Nonnull
                                                                    LegalDocument legalDocument)

Description copied from interface: LegalDocumentService

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

Specified by:

createLegalDocument in interface LegalDocumentService

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
public LglCntntMDocCategoryFluentHelper getAllLglCntntMDocCategory()

Description copied from interface: LegalDocumentService

Fetch multiple LglCntntMDocCategory entities.

Specified by:

getAllLglCntntMDocCategory in interface LegalDocumentService

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
public LglCntntMDocCategoryByKeyFluentHelper getLglCntntMDocCategoryByKey(UUID lglCntntMDocCategoryUUID)

Description copied from interface: LegalDocumentService

Fetch a single LglCntntMDocCategory entity using key fields.

Specified by:

getLglCntntMDocCategoryByKey in interface LegalDocumentService

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
public LglCntntMDocCategoryCreateFluentHelper createLglCntntMDocCategory(@Nonnull
                                                                                  LglCntntMDocCategory lglCntntMDocCategory)

Description copied from interface: LegalDocumentService

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

Specified by:

createLglCntntMDocCategory in interface LegalDocumentService

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
public LglCntntMDocParCategoryFluentHelper getAllLglCntntMDocParCategory()

Description copied from interface: LegalDocumentService

Fetch multiple LglCntntMDocParCategory entities.

Specified by:

getAllLglCntntMDocParCategory in interface LegalDocumentService

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
public LglCntntMDocParCategoryByKeyFluentHelper getLglCntntMDocParCategoryByKey(UUID lglCntntMDocParCatUUID)

Description copied from interface: LegalDocumentService

Fetch a single LglCntntMDocParCategory entity using key fields.

Specified by:

getLglCntntMDocParCategoryByKey in interface LegalDocumentService

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
public LglCntntMDocParCategoryCreateFluentHelper createLglCntntMDocParCategory(@Nonnull
                                                                                        LglCntntMDocParCategory lglCntntMDocParCategory)

Description copied from interface: LegalDocumentService

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

Specified by:

createLglCntntMDocParCategory in interface LegalDocumentService

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
public LglDocStampFluentHelper getAllLglDocStamp()

Description copied from interface: LegalDocumentService

Fetch multiple LglDocStamp entities.

Specified by:

getAllLglDocStamp in interface LegalDocumentService

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
public LglDocStampByKeyFluentHelper getLglDocStampByKey(UUID lglCntntMDocumentStampUUID)

Description copied from interface: LegalDocumentService

Fetch a single LglDocStamp entity using key fields.

Specified by:

getLglDocStampByKey in interface LegalDocumentService

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
public LglDocStampCreateFluentHelper createLglDocStamp(@Nonnull
                                                                LglDocStamp lglDocStamp)

Description copied from interface: LegalDocumentService

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

Specified by:

createLglDocStamp in interface LegalDocumentService

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.