com.sap.cloud.sdk.s4hana.datamodel.odata.services.ProcessOrderConfirmationService 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.namespaces.processorderconfirmation.ProcOrdConfirmationByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.processorderconfirmation.ProcOrdConfirmationFluentHelper;

/**
 * 
 * This service enables you to read process order confirmations.
 * 
 * 
 * Business
 * Documentation
 * 
 * 
 * Reference: SAP
 * API Business Hub
 * 
 * Details:
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * OData Service: API_PROC_ORDER_CONFIRMATION
API Version: 1
Communication Scenario: Production Planning Integration (SAP_COM_0104)
Scope Items: Material Requirements Planning (J44)
 * 
 */
public interface ProcessOrderConfirmationService
{

    /**
     * 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_PROC_ORDER_CONFIRMATION;v=0001";

    /**
     * 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
    ProcessOrderConfirmationService withServicePath( @Nonnull final String servicePath );

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

    /**
     * Fetch a single
     * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.processorderconfirmation.ProcOrdConfirmation
     * ProcOrdConfirmation} entity using key fields.
     * 
     * @param processOrderConfirmation
     *            Number used to identify an operation in the confirmation.
     *            
     *            Constraints: Not nullable, Maximum length: 10
     *            
     * @param operationConfirmationCount
     *            Counter that enumerates confirmations for an operation. If more than one confirmation was created for
     *            an operation then the confirmation counter together with the confirmation number unambiguously
     *            identifies the individual confirmation.
     *            
     *            Constraints: Not nullable, Maximum length: 8
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.processorderconfirmation.ProcOrdConfirmation
     *         ProcOrdConfirmation} 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.processorderconfirmation.ProcOrdConfirmationByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    ProcOrdConfirmationByKeyFluentHelper
        getProcOrdConfirmationByKey( final String processOrderConfirmation, final String operationConfirmationCount );

}
OData Service:	API_PROC_ORDER_CONFIRMATION
API Version:	1
Communication Scenario:	Production Planning Integration (SAP_COM_0104)
Scope Items:	Material Requirements Planning (J44)