com.sap.cloud.sdk.s4hana.datamodel.odata.services.InspectionMethodService 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.inspectionmethod.InspectionMethodByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inspectionmethod.InspectionMethodFluentHelper;

/**
 * 
 * This service enables you to read inspection methods from the SAP S/4HANA system. An inspection method describes the
 * procedure for performing the quality inspection of a characteristic.
 * 
 * 
 * Business
 * Documentation
 * 
 * 
 * Reference: SAP
 * API Business Hub
 * 
 * Details:
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * OData Service: API_INSPECTIONMETHOD_SRV
API Version: 1
Communication Scenario: Inspection Master Data Integration (SAP_COM_0110)
Scope Items: Quality Management in Discrete Manufacturing (1E1),
 * Quality Management in Procurement (1FM),
 * Quality Management in Sales (1MP),
 * Quality Management in Stock Handling (1MR),
 * Nonconformance Management (2QN)
Authentication Methods: Basic, x509, OAuth2
Business Object: InspectionMethod
 * 
 */
public interface InspectionMethodService
{

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

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

    /**
     * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inspectionmethod.InspectionMethod
     * InspectionMethod} entity using key fields.
     * 
     * @param inspectionMethodVersion
     *            Version Number of the Inspection Method
     *            
     *            Constraints: Not nullable, Maximum length: 6
     *            
     * @param inspectionMethodPlant
     *            Key, that identifies a plant.
     *            
     *            Constraints: Not nullable, Maximum length: 4
     *            
     * @param inspectionMethod
     *            Name that uniquely identifies an inspection method within a plant.
     *            
     *            Constraints: Not nullable, Maximum length: 8
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.inspectionmethod.InspectionMethod
     *         InspectionMethod} 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.inspectionmethod.InspectionMethodByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    InspectionMethodByKeyFluentHelper getInspectionMethodByKey(
        final String inspectionMethod,
        final String inspectionMethodVersion,
        final String inspectionMethodPlant );

}

OData Service:	API_INSPECTIONMETHOD_SRV
API Version:	1
Communication Scenario:	Inspection Master Data Integration (SAP_COM_0110)
Scope Items:	Quality Management in Discrete Manufacturing (1E1), * Quality Management in Procurement (1FM), * Quality Management in Sales (1MP), * Quality Management in Stock Handling (1MR), * Nonconformance Management (2QN)
Authentication Methods:	Basic, x509, OAuth2
Business Object:	InspectionMethod