com.sap.cloud.sdk.s4hana.datamodel.odata.services.ProcessOrderService 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.processorder.ProcessOrderByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.processorder.ProcessOrderComponentByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.processorder.ProcessOrderComponentFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.processorder.ProcessOrderFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.processorder.ProcessOrderItemByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.processorder.ProcessOrderItemFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.processorder.ProcessOrderOperationByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.processorder.ProcessOrderOperationFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.processorder.ProcessOrderStatusByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.processorder.ProcessOrderStatusFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.processorder.batch.ProcessOrderServiceBatch;

/**
 * 
 * This service enables you to read order headers, items, operations, components, statuses, and production/resource
 * tools (PRTs) belonging to process orders.
 * 
 * 
 * Business
 * Documentation
 * 
 * 
 * Reference: SAP API
 * Business Hub
 * 
 * Details:
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * OData Service: API_PROCESS_ORDERS
API Version: 1
Communication Scenario: Production Planning Integration (SAP_COM_0104)
Scope Items: Material Requirements Planning (J44)
 * 
 */
public interface ProcessOrderService 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_PROCESS_ORDERS";

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

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

    /**
     * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.processorder.ProcessOrder ProcessOrder}
     * entity using key fields.
     * 
     * @param processOrder
     *            Manufacturing Order ID
     *            
     *            Constraints: Not nullable, Maximum length: 12
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.processorder.ProcessOrder ProcessOrder} 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.processorder.ProcessOrderByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    ProcessOrderByKeyFluentHelper getProcessOrderByKey( final String processOrder );

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

    /**
     * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.processorder.ProcessOrderComponent
     * ProcessOrderComponent} entity using key fields.
     * 
     * @param reservationItem
     *            Reservation Item
     *            
     *            Constraints: Not nullable, Maximum length: 4
     *            
     * @param reservation
     *            Number of Reservation/Dependent Requirement
     *            
     *            Constraints: Not nullable, Maximum length: 10
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.processorder.ProcessOrderComponent
     *         ProcessOrderComponent} 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.processorder.ProcessOrderComponentByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    ProcessOrderComponentByKeyFluentHelper
        getProcessOrderComponentByKey( final String reservation, final String reservationItem );

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

    /**
     * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.processorder.ProcessOrderItem
     * ProcessOrderItem} entity using key fields.
     * 
     * @param manufacturingOrderItem
     *            Manufacturing Order Item ID
     *            
     *            Constraints: Not nullable, Maximum length: 4
     *            
     * @param manufacturingOrder
     *            Manufacturing Order ID
     *            
     *            Constraints: Not nullable, Maximum length: 12
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.processorder.ProcessOrderItem
     *         ProcessOrderItem} 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.processorder.ProcessOrderItemByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    ProcessOrderItemByKeyFluentHelper
        getProcessOrderItemByKey( final String manufacturingOrder, final String manufacturingOrderItem );

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

    /**
     * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.processorder.ProcessOrderOperation
     * ProcessOrderOperation} entity using key fields.
     * 
     * @param orderIntBillOfOperationsItem
     *            Order Internal Bill of Operations Item
     *            
     *            Constraints: Not nullable, Maximum length: 8
     *            
     * @param orderInternalBillOfOperations
     *            Order Internal Bill of Operations ID
     *            
     *            Constraints: Not nullable, Maximum length: 10
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.processorder.ProcessOrderOperation
     *         ProcessOrderOperation} 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.processorder.ProcessOrderOperationByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    ProcessOrderOperationByKeyFluentHelper getProcessOrderOperationByKey(
        final String orderInternalBillOfOperations,
        final String orderIntBillOfOperationsItem );

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

    /**
     * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.processorder.ProcessOrderStatus
     * ProcessOrderStatus} entity using key fields.
     * 
     * @param manufacturingOrder
     *            Order Number
     *            
     *            Constraints: Not nullable, Maximum length: 12
     *            
     * @param statusCode
     *            Object status
     *            
     *            Constraints: Not nullable, Maximum length: 5
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.processorder.ProcessOrderStatus
     *         ProcessOrderStatus} 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.processorder.ProcessOrderStatusByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    ProcessOrderStatusByKeyFluentHelper
        getProcessOrderStatusByKey( final String manufacturingOrder, final String statusCode );

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