@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultLegalDocumentService") public class DefaultLegalDocumentService extends Object implements LegalDocumentService
This synchronous inbound service helps you to create and read legal documents through an API call. 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..
Reference: SAP API Business Hub
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 |
DEFAULT_SERVICE_PATH
Constructor and Description |
---|
DefaultLegalDocumentService()
Creates a service using
LegalDocumentService.DEFAULT_SERVICE_PATH to send the requests. |
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. |
LglDocStampCreateFluentHelper |
createLglDocStamp(LglDocStamp lglDocStamp)
Create a new
LglDocStamp
entity and save it to the S/4HANA system. |
LegalDocumentFluentHelper |
getAllLegalDocument()
Fetch multiple
LegalDocument entities. |
LglDocStampFluentHelper |
getAllLglDocStamp()
Fetch multiple
LglDocStamp
entities. |
LegalDocumentByKeyFluentHelper |
getLegalDocumentByKey(UUID lglCntntMDocumentUUID)
Fetch a single
LegalDocument 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.
|
public DefaultLegalDocumentService()
LegalDocumentService.DEFAULT_SERVICE_PATH
to send the requests.@Nonnull public DefaultLegalDocumentService withServicePath(@Nonnull String servicePath)
LegalDocumentService
withServicePath
in interface LegalDocumentService
servicePath
- Service path that will override the default.@Nonnull public DefaultLegalDocumentServiceBatch batch()
batch
in interface BatchService<LegalDocumentServiceBatch>
@Nonnull public LegalDocumentFluentHelper getAllLegalDocument()
LegalDocumentService
LegalDocument
entities.getAllLegalDocument
in interface LegalDocumentService
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.@Nonnull public LegalDocumentByKeyFluentHelper getLegalDocumentByKey(UUID lglCntntMDocumentUUID)
LegalDocumentService
LegalDocument
entity using key fields.getLegalDocumentByKey
in interface LegalDocumentService
lglCntntMDocumentUUID
- Universal Unique Identifier
Constraints: Not nullable
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.@Nonnull public LegalDocumentCreateFluentHelper createLegalDocument(@Nonnull LegalDocument legalDocument)
LegalDocumentService
LegalDocument
entity and save it to the S/4HANA system.createLegalDocument
in interface LegalDocumentService
legalDocument
- LegalDocument
entity object that will be created in the S/4HANA system.LegalDocument
entity. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public LglDocStampFluentHelper getAllLglDocStamp()
LegalDocumentService
LglDocStamp
entities.getAllLglDocStamp
in interface LegalDocumentService
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.@Nonnull public LglDocStampByKeyFluentHelper getLglDocStampByKey(UUID lglCntntMDocumentStampUUID)
LegalDocumentService
LglDocStamp
entity using key fields.getLglDocStampByKey
in interface LegalDocumentService
lglCntntMDocumentStampUUID
- Universal Unique Identifier
Constraints: Not nullable
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.@Nonnull public LglDocStampCreateFluentHelper createLglDocStamp(@Nonnull LglDocStamp lglDocStamp)
LegalDocumentService
LglDocStamp
entity and save it to the S/4HANA system.createLglDocStamp
in interface LegalDocumentService
lglDocStamp
- LglDocStamp
entity object that will be created in the S/4HANA system.LglDocStamp
entity.
To perform execution, call the
execute
method on the fluent helper object.Copyright © 2020 SAP SE. All rights reserved.