com.sap.cloud.sdk.s4hana.datamodel.odata.services.LegalDocumentService Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2019 SAP SE or an SAP affiliate company. All rights reserved.
 */

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

import java.util.UUID;

import javax.annotation.Nonnull;

import com.sap.cloud.sdk.s4hana.datamodel.odata.helper.batch.BatchService;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.legaldocument.LegalDocument;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.legaldocument.LegalDocumentByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.legaldocument.LegalDocumentCreateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.legaldocument.LegalDocumentFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.legaldocument.LglDocStamp;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.legaldocument.LglDocStampByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.legaldocument.LglDocStampCreateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.legaldocument.LglDocStampFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.legaldocument.batch.LegalDocumentServiceBatch;

/**
 * 
 * This service enables you to read and create Legal Document with the data provided in a payload, in an API call. It is
 * based on the OData protocol, and can be consumed in Integration scenarios or other user interfaces.
 * 
 * 
 * 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 Legal Content (1XV)
Authentication Methods: Basic, x509
 * 
 */
public interface LegalDocumentService extends BatchService
{

    /**
     * If no other path was provided via the {@link #withServicePath(String)} method, this is the default service path
     * used to access the endpoint.
     * 
     */
    String DEFAULT_SERVICE_PATH = "/sap/opu/odata/sap/API_LEGAL_DOCUMENT_SRV";

    /**
     * Overrides the default service path and returns a new service instance with the specified service path. Also
     * adjusts the respective entity URLs.
     * 
     * @param servicePath
     *            Service path that will override the default.
     * @return A new service instance with the specified service path.
     */
    @Nonnull
    LegalDocumentService withServicePath( @Nonnull final String servicePath );

    /**
     * Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.legaldocument.LegalDocument
     * LegalDocument} entities.
     * 
     * @return A fluent helper to fetch multiple
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.legaldocument.LegalDocument 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
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.legaldocument.LegalDocumentFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    LegalDocumentFluentHelper getAllLegalDocument();

    /**
     * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.legaldocument.LegalDocument
     * LegalDocument} entity using key fields.
     * 
     * @param lglCntntMDocumentUUID
     *            Universal Unique Identifier
     *            
     *            Constraints: Not nullable
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.legaldocument.LegalDocument 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
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.legaldocument.LegalDocumentByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    LegalDocumentByKeyFluentHelper getLegalDocumentByKey( final UUID lglCntntMDocumentUUID );

    /**
     * Create a new {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.legaldocument.LegalDocument
     * LegalDocument} entity and save it to the S/4HANA system.
     * 
     * @param legalDocument
     *            {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.legaldocument.LegalDocument LegalDocument}
     *            entity object that will be created in the S/4HANA system.
     * @return A fluent helper to create a new
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.legaldocument.LegalDocument LegalDocument}
     *         entity. To perform execution, call the
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.legaldocument.LegalDocumentCreateFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    LegalDocumentCreateFluentHelper createLegalDocument( @Nonnull final LegalDocument legalDocument );

    /**
     * Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.legaldocument.LglDocStamp LglDocStamp}
     * entities.
     * 
     * @return A fluent helper to fetch multiple
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.legaldocument.LglDocStamp 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
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.legaldocument.LglDocStampFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    LglDocStampFluentHelper getAllLglDocStamp();

    /**
     * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.legaldocument.LglDocStamp LglDocStamp}
     * entity using key fields.
     * 
     * @param lglCntntMDocumentStampUUID
     *            Universal Unique Identifier
     *            
     *            Constraints: Not nullable
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.legaldocument.LglDocStamp 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
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.legaldocument.LglDocStampByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    LglDocStampByKeyFluentHelper getLglDocStampByKey( final UUID lglCntntMDocumentStampUUID );

    /**
     * Create a new {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.legaldocument.LglDocStamp LglDocStamp}
     * entity and save it to the S/4HANA system.
     * 
     * @param lglDocStamp
     *            {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.legaldocument.LglDocStamp LglDocStamp}
     *            entity object that will be created in the S/4HANA system.
     * @return A fluent helper to create a new
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.legaldocument.LglDocStamp LglDocStamp} entity.
     *         To perform execution, call the
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.legaldocument.LglDocStampCreateFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    LglDocStampCreateFluentHelper createLglDocStamp( @Nonnull final LglDocStamp lglDocStamp );

}
OData Service:	API_LEGAL_DOCUMENT_SRV
API Version:	1
Communication Scenario:	Legal Document Integration (SAP_COM_0178)
Scope Items:	SAP S/4HANA for Legal Content (1XV)
Authentication Methods:	Basic, x509