com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefectClassService 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.defectclass.DefectClassByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectclass.DefectClassFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectclass.DefectClassTextByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectclass.DefectClassTextFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectclass.batch.DefectClassServiceBatch;

/**
 * 
 * This service enables you to read defect classes and their language-dependent texts from the SAP S/4HANA Cloud system.
 * The defect class in quality management is based on a qualitative defect valuation according to impact, for example,
 * critical defect or minor defect.
 * 
 * 
 * Business
 * Documentation
 * 
 * 
 * Reference: SAP API
 * Business Hub
 * 
 * Details:
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * OData Service: API_DEFECTCLASS_SRV
API Version: 1
Communication Scenario: Defect Processing Integration (SAP_COM_0153)
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: Defect
 * 
 */
public interface DefectClassService 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_DEFECTCLASS_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
    DefectClassService withServicePath( @Nonnull final String servicePath );

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

    /**
     * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectclass.DefectClass DefectClass}
     * entity using key fields.
     * 
     * @param defectClass
     *            Categorizes the possible defects into classes according to a defect valuation based on the results
     *            caused by the defect.
     *            
     *            Constraints: Not nullable, Maximum length: 2
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectclass.DefectClass DefectClass} 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.defectclass.DefectClassByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    DefectClassByKeyFluentHelper getDefectClassByKey( final String defectClass );

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

    /**
     * Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectclass.DefectClassText
     * DefectClassText} entity using key fields.
     * 
     * @param language
     *            The language key indicates
     *            
     *            Constraints: Not nullable, Maximum length: 2
     *            
     * @param defectClass
     *            Categorizes the possible defects into classes according to a defect valuation based on the results
     *            caused by the defect.
     *            
     *            Constraints: Not nullable, Maximum length: 2
     *            
     * @return A fluent helper to fetch a single
     *         {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectclass.DefectClassText DefectClassText}
     *         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.defectclass.DefectClassTextByKeyFluentHelper#execute
     *         execute} method on the fluent helper object.
     */
    @Nonnull
    DefectClassTextByKeyFluentHelper getDefectClassTextByKey( final String defectClass, final String language );

}
OData Service:	API_DEFECTCLASS_SRV
API Version:	1
Communication Scenario:	Defect Processing Integration (SAP_COM_0153)
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:	Defect