com.sap.cloud.sdk.s4hana.datamodel.odata.services.ReservationDocumentService 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 javax.annotation.Nonnull;

import com.sap.cloud.sdk.s4hana.datamodel.odata.helper.batch.BatchService;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.reservationdocument.ReservationDocumentHeaderByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.reservationdocument.ReservationDocumentHeaderFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.reservationdocument.ReservationDocumentItemByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.reservationdocument.ReservationDocumentItemFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.reservationdocument.batch.ReservationDocumentServiceBatch;

/**
 * 
 * This service enables you to retrieve, create and delete reservation documents. For example, a user might create a
 * reservation for a material with some quantity and assign that reserved material to a cost center, a sales order or an
 * asset. A reservation can also be created for a transfer posting from one plant to another. The service also allows to
 * delete existing reservation documents. It can be consumed by external systems and user interfaces.
 * 
 * 
 * Business
 * Documentation
 * 
 * 
 * Reference: SAP
 * API Business Hub
 * 
 * Details:
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * OData Service: API_RESERVATION_DOCUMENT_SRV
API Version: 1
Communication Scenario: Reservation Integration (SAP_COM_0112)
Scope Items: Core Inventory Management (BMC)
Authentication Methods: Basic, x509
 * 
 */
public interface ReservationDocumentService 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_RESERVATION_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
    ReservationDocumentService withServicePath( @Nonnull final String servicePath );

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

    /**
     * Fetch a single
     * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.reservationdocument.ReservationDocumentHeader
     * ReservationDocumentHeader} entity using key fields.
     * 
     * @param reservation
     *            Alphanumeric key uniquely identifying the document.
     *            
     *            Constraints: Not nullable, Maximum length: 10
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.reservationdocument.ReservationDocumentHeader
     *         ReservationDocumentHeader} 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.reservationdocument.ReservationDocumentHeaderByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    ReservationDocumentHeaderByKeyFluentHelper getReservationDocumentHeaderByKey( final String reservation );

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

    /**
     * Fetch a single
     * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.reservationdocument.ReservationDocumentItem
     * ReservationDocumentItem} entity using key fields.
     * 
     * @param reservationItem
     *            Specifies the number that uniquely identifies an item in .
     *            
     *            Constraints: Not nullable, Maximum length: 4
     *            
     * @param recordType
     *            Record type
     *            
     *            Constraints: Not nullable, Maximum length: 1
     *            
     * @param reservation
     *            Alphanumeric key uniquely identifying the document.
     *            
     *            Constraints: Not nullable, Maximum length: 10
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.reservationdocument.ReservationDocumentItem
     *         ReservationDocumentItem} 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.reservationdocument.ReservationDocumentItemByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    ReservationDocumentItemByKeyFluentHelper getReservationDocumentItemByKey(
        final String reservation,
        final String reservationItem,
        final String recordType );

}
OData Service:	API_RESERVATION_DOCUMENT_SRV
API Version:	1
Communication Scenario:	Reservation Integration (SAP_COM_0112)
Scope Items:	Core Inventory Management (BMC)
Authentication Methods:	Basic, x509