com.sap.cloud.sdk.s4hana.datamodel.odata.services.BufferProfileService 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.bufferprofile.ProfileAssignedToPlantByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.bufferprofile.ProfileAssignedToPlantFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.bufferprofile.ProfileDetailsByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.bufferprofile.ProfileDetailsFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.bufferprofile.batch.BufferProfileServiceBatch;

/**
 * 
 * This synchronous inbound service enables external systems to read buffer profile data through API calls. You can use
 * it to let external systems retrieve data, such as, lead time factor and variability factor, and also for each plant,
 * read spike horizon constant (SHC), spike horizon DLT multiplier, spike threshold factor, and on-hand alert threshold
 * factor.
 * 
 * 
 * Business
 * Documentation
 * 
 * 
 * Reference: SAP
 * API Business Hub
 * 
 * Details:
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * OData Service: API_BUFFER_PROFILE_SRV
API Version: 1
Communication Scenario: Buffer Profile Integration (SAP_COM_0349)
Scope Items: Demand-Driven Buffer Level Management (1Y2)
Authentication Methods: Basic, x509
 * 
 */
public interface BufferProfileService 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_BUFFER_PROFILE_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
    BufferProfileService withServicePath( @Nonnull final String servicePath );

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

    /**
     * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.bufferprofile.ProfileDetails
     * ProfileDetails} entity using key fields.
     * 
     * @param isMinOrderQtyConsidered
     *            The lowest product quantity for which an order can be placed to replenish the stock buffer, decided by
     *            logistical, contractual or cost considerations.
     *            
     *            Constraints: Not nullable, Maximum length: 1
     *            
     * @param variabilityCode
     *            Classifying a product or component into type X, Y or Z based on the variation in its usage, with
     *            products classified as type X having the lowest variation and products classified as type Z having the
     *            highest variation.
     *            
     *            Constraints: Not nullable, Maximum length: 1
     *            
     * @param replenishmentLeadTimeCode
     *            Classifying a product or component into type E, F or G based on its lead time, with products
     *            classified as type E having the shortest lead time and products classified as type G having the
     *            longest lead time. An EFG classification is typically used together with the procurement type for a
     *            product or component.
     *            
     *            Constraints: Not nullable, Maximum length: 1
     *            
     * @param plant
     *            Key uniquely identifying a plant.
     *            
     *            Constraints: Not nullable, Maximum length: 4
     *            
     * @param procurementType
     *            Categories which specify how a DD-relevant product or component is procured. Typically, products are
     *            categorized as Make, Buy or Transfer.
     *            
     *            Constraints: Not nullable, Maximum length: 1
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.bufferprofile.ProfileDetails ProfileDetails}
     *         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.bufferprofile.ProfileDetailsByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    ProfileDetailsByKeyFluentHelper getProfileDetailsByKey(
        final String plant,
        final String procurementType,
        final String variabilityCode,
        final String replenishmentLeadTimeCode,
        final String isMinOrderQtyConsidered );

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

    /**
     * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.bufferprofile.ProfileAssignedToPlant
     * ProfileAssignedToPlant} entity using key fields.
     * 
     * @param plant
     *            Key uniquely identifying a plant.
     *            
     *            Constraints: Not nullable, Maximum length: 4
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.bufferprofile.ProfileAssignedToPlant
     *         ProfileAssignedToPlant} 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.bufferprofile.ProfileAssignedToPlantByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    ProfileAssignedToPlantByKeyFluentHelper getProfileAssignedToPlantByKey( final String plant );

}
OData Service:	API_BUFFER_PROFILE_SRV
API Version:	1
Communication Scenario:	Buffer Profile Integration (SAP_COM_0349)
Scope Items:	Demand-Driven Buffer Level Management (1Y2)
Authentication Methods:	Basic, x509