• Home
• com.sap.cloud.s4hana.datamodel
• odata-api
• 2.22.1
• source code
• ProcessOrderConfirmationV2Service.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

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

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

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

import java.time.LocalDateTime;
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.processorderconfirmationv2.CancelProcOrdConfFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.processorderconfirmationv2.ProcOrdConf2;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.processorderconfirmationv2.ProcOrdConf2ByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.processorderconfirmationv2.ProcOrdConf2CreateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.processorderconfirmationv2.ProcOrdConf2FluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.processorderconfirmationv2.ProcOrdConfMatlDocItm;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.processorderconfirmationv2.ProcOrdConfMatlDocItmByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.processorderconfirmationv2.ProcOrdConfMatlDocItmCreateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.processorderconfirmationv2.ProcOrdConfMatlDocItmFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.processorderconfirmationv2.batch.ProcessOrderConfirmationV2ServiceBatch;

/**
 * 

 * This synchronous inbound service enables you to create header and time ticket confirmations, read confirmations, and
 * cancel confirmations for process orders.
 * 
 * 

 * Business
 * Documentation
 * 
 * 

 * Reference: SAP
 * API Business Hub
 * 
 * 
Details:
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
OData Service:
API_PROC_ORDER_CONFIRMATION_2_SRV
API Version:
1
Communication Scenario:
Production Planning Integration (SAP_COM_0104), Manufacturing Execution - Order and Confirmation Integration
 * (SAP_COM_0522)
Scope Items:
 Make-to-Stock Production - Discrete Manufacturing (BJ5),
 * Make-to-Stock - Process Manufacturing Based on Process Order
 * (BJ8), Material Requirements Planning (J44),
 * Integration of Third Party MES for Discrete Industry
 * (3W4)
Authentication Methods:
Basic, x509
Business Object:
ProcessOrder
 * 
 */
public interface ProcessOrderConfirmationV2Service 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_PROC_ORDER_CONFIRMATION_2_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
    ProcessOrderConfirmationV2Service withServicePath( @Nonnull final String servicePath );

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

    /**
     * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.processorderconfirmationv2.ProcOrdConf2
     * ProcOrdConf2} entity using key fields.
     * 
     * @param confirmationCount
     *            Identifier of Single Order Confirmation
     *            

     *            Constraints: Not nullable, Maximum length: 8
     *            
     * @param confirmationGroup
     *            Collective ID of Order Confirmations
     *            

     *            Constraints: Not nullable, Maximum length: 10
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.processorderconfirmationv2.ProcOrdConf2
     *         ProcOrdConf2} 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.processorderconfirmationv2.ProcOrdConf2ByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    ProcOrdConf2ByKeyFluentHelper
        getProcOrdConf2ByKey( final String confirmationGroup, final String confirmationCount );

    /**
     * Create a new {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.processorderconfirmationv2.ProcOrdConf2
     * ProcOrdConf2} entity and save it to the S/4HANA system.
     * 
     * @param procOrdConf2
     *            {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.processorderconfirmationv2.ProcOrdConf2
     *            ProcOrdConf2} 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.processorderconfirmationv2.ProcOrdConf2
     *         ProcOrdConf2} entity. To perform execution, call the
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.processorderconfirmationv2.ProcOrdConf2CreateFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    ProcOrdConf2CreateFluentHelper createProcOrdConf2( @Nonnull final ProcOrdConf2 procOrdConf2 );

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

    /**
     * Fetch a single
     * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.processorderconfirmationv2.ProcOrdConfMatlDocItm
     * ProcOrdConfMatlDocItm} entity using key fields.
     * 
     * @param materialDocument
     *            Alphanumeric key uniquely identifying the document.
     *            

     *            Constraints: Not nullable, Maximum length: 10
     *            
     * @param confirmationCount
     *            Identifier of Single Order Confirmation
     *            

     *            Constraints: Not nullable, Maximum length: 8
     *            
     * @param materialDocumentItem
     *            Specifies the number that uniquely identifies an item in .
     *            

     *            Constraints: Not nullable, Maximum length: 4
     *            
     * @param materialDocumentYear
     *            Calendar year in which the material document was posted.
     *            

     *            Constraints: Not nullable, Maximum length: 4
     *            
     * @param confirmationGroup
     *            Collective ID of Order Confirmations
     *            

     *            Constraints: Not nullable, Maximum length: 10
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.processorderconfirmationv2.ProcOrdConfMatlDocItm
     *         ProcOrdConfMatlDocItm} 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.processorderconfirmationv2.ProcOrdConfMatlDocItmByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    ProcOrdConfMatlDocItmByKeyFluentHelper getProcOrdConfMatlDocItmByKey(
        final String confirmationGroup,
        final String confirmationCount,
        final String materialDocument,
        final String materialDocumentItem,
        final String materialDocumentYear );

    /**
     * Create a new
     * {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.processorderconfirmationv2.ProcOrdConfMatlDocItm
     * ProcOrdConfMatlDocItm} entity and save it to the S/4HANA system.
     * 
     * @param procOrdConfMatlDocItm
     *            {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.processorderconfirmationv2.ProcOrdConfMatlDocItm
     *            ProcOrdConfMatlDocItm} 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.processorderconfirmationv2.ProcOrdConfMatlDocItm
     *         ProcOrdConfMatlDocItm} entity. To perform execution, call the
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.processorderconfirmationv2.ProcOrdConfMatlDocItmCreateFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    ProcOrdConfMatlDocItmCreateFluentHelper
        createProcOrdConfMatlDocItm( @Nonnull final ProcOrdConfMatlDocItm procOrdConfMatlDocItm );

    /**
     * 

     * Creates a fluent helper for the CancelProcOrdConf OData function import.
     * 
     * 
     * @param externalSystemConfirmation
     *            External Key
     *            

     *            
     *            

     *            Constraints: Nullable
     *            
     *            

     *            Original parameter name from the Odata EDM: ExternalSystemConfirmation
     *            
     * @param confirmationCount
     *            Order Confirmation
     *            

     *            
     *            

     *            Constraints: Not nullable, Maximum length: 8
     *            
     *            

     *            Original parameter name from the Odata EDM: ConfirmationCount
     *            
     * @param confirmationText
     *            Confirmation Text
     *            

     *            
     *            

     *            Constraints: Nullable, Maximum length: 40
     *            
     *            

     *            Original parameter name from the Odata EDM: ConfirmationText
     *            
     * @param postingDate
     *            Posting Date
     *            

     *            
     *            

     *            Constraints: Nullable, Precision: 0
     *            
     *            

     *            Original parameter name from the Odata EDM: PostingDate
     *            
     * @param confirmationGroup
     *            Confirmation Group
     *            

     *            
     *            

     *            Constraints: Not nullable, Maximum length: 10
     *            
     *            

     *            Original parameter name from the Odata EDM: ConfirmationGroup
     *            
     * @return A fluent helper object that will execute the CancelProcOrdConf OData function import with the
     *         provided parameters. To perform execution, call the
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.processorderconfirmationv2.CancelProcOrdConfFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    CancelProcOrdConfFluentHelper cancelProcOrdConf(
        final String confirmationGroup,
        final String confirmationCount,
        final LocalDateTime postingDate,
        final String confirmationText,
        final UUID externalSystemConfirmation );

}