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

Interface LegalDocumentService

All Superinterfaces:
BatchService<LegalDocumentServiceBatch>
All Known Implementing Classes:
DefaultLegalDocumentService
@Deprecated public interface LegalDocumentService extends BatchService<LegalDocumentServiceBatch>
Deprecated.
The service and all its related classes are deprecated. Please use the odata generator to generate the VDM.

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 Business Accelerator Hub

Details:

OData Service: API_LEGAL_DOCUMENT_SRV
API Version: 1.1.0
Minimum ERP Version: 2302
Communication Scenario: Legal Document Integration(SAP_COM_0178), Procurement - Supplier Quotation Management Integration(SAP_COM_0760)
Scope Items: SAP S/4HANA for Enterprise Contract Management(1XV), Direct Material Sourcing(4RD)
Authentication Methods: x509
Business Object: Legal Document

  • Field Details

  • Method Details

    • withServicePath

      @Nonnull LegalDocumentService withServicePath(@Nonnull String servicePath)
      Deprecated.
      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()
      Deprecated.
      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)
      Deprecated.
      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)
      Deprecated.
      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()
      Deprecated.
      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)
      Deprecated.
      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)
      Deprecated.
      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()
      Deprecated.
      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)
      Deprecated.
      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)
      Deprecated.
      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()
      Deprecated.
      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)
      Deprecated.
      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)
      Deprecated.
      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.

    • setLegalDocumentToAccepted

      @Nonnull SetLegalDocumentToAcceptedFluentHelper setLegalDocumentToAccepted(@Nonnull UUID lglCntntMDocumentUUID)
      Deprecated.

      Creates a fluent helper for the SetLegalDocumentToAccepted OData function import.

      Parameters:
      lglCntntMDocumentUUID - Universal Unique ID

      Constraints: none

      Original parameter name from the Odata EDM: LglCntntMDocumentUUID

      Returns:
      A fluent helper object that will execute the SetLegalDocumentToAccepted OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.