com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefectCodeAndCodeGroupService 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 javax.annotation.Nonnull;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectcodeandcodegroup.DefectCodeByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectcodeandcodegroup.DefectCodeFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectcodeandcodegroup.DefectCodeGroupByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectcodeandcodegroup.DefectCodeGroupFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectcodeandcodegroup.DefectCodeGroupTextByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectcodeandcodegroup.DefectCodeGroupTextFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectcodeandcodegroup.DefectCodeTextByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectcodeandcodegroup.DefectCodeTextFluentHelper;
/**
*
* This service enables you to read defect codes and code groups and their language-dependent texts from the SAP S/4HANA
* Cloud system. The combination of defect code group and code uniquely identifies the type of the defect in quality
* management in a coded format.
*
*
*
* Reference: SAP API
* Business Hub
*
* Details:
*
*
* OData Service:
* API_DEFECTCODE_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 DefectCodeAndCodeGroupService
{
/**
* 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_DEFECTCODE_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
DefectCodeAndCodeGroupService withServicePath( @Nonnull final String servicePath );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectcodeandcodegroup.DefectCode
* DefectCode} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectcodeandcodegroup.DefectCode DefectCode}
* 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.defectcodeandcodegroup.DefectCodeFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
DefectCodeFluentHelper getAllDefectCode();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectcodeandcodegroup.DefectCode
* DefectCode} entity using key fields.
*
* @param defectCode
* Defect Code
*
* Constraints: Not nullable, Maximum length: 4
*
* @param defectCodeGroup
* Defect Code Group
*
* Constraints: Not nullable, Maximum length: 8
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectcodeandcodegroup.DefectCode DefectCode}
* 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.defectcodeandcodegroup.DefectCodeByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
DefectCodeByKeyFluentHelper getDefectCodeByKey( final String defectCodeGroup, final String defectCode );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectcodeandcodegroup.DefectCodeGroup
* DefectCodeGroup} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectcodeandcodegroup.DefectCodeGroup
* DefectCodeGroup} 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.defectcodeandcodegroup.DefectCodeGroupFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
DefectCodeGroupFluentHelper getAllDefectCodeGroup();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectcodeandcodegroup.DefectCodeGroup
* DefectCodeGroup} entity using key fields.
*
* @param defectCodeGroup
* Defect Code Group
*
* Constraints: Not nullable, Maximum length: 8
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectcodeandcodegroup.DefectCodeGroup
* DefectCodeGroup} 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.defectcodeandcodegroup.DefectCodeGroupByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
DefectCodeGroupByKeyFluentHelper getDefectCodeGroupByKey( final String defectCodeGroup );
/**
* Fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectcodeandcodegroup.DefectCodeGroupText
* DefectCodeGroupText} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectcodeandcodegroup.DefectCodeGroupText
* DefectCodeGroupText} 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.defectcodeandcodegroup.DefectCodeGroupTextFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
DefectCodeGroupTextFluentHelper getAllDefectCodeGroupText();
/**
* Fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectcodeandcodegroup.DefectCodeGroupText
* DefectCodeGroupText} entity using key fields.
*
* @param defectCodeGroup
* Defect Code Group
*
* Constraints: Not nullable, Maximum length: 8
*
* @param language
* The language key indicates
*
* Constraints: Not nullable, Maximum length: 2
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectcodeandcodegroup.DefectCodeGroupText
* DefectCodeGroupText} 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.defectcodeandcodegroup.DefectCodeGroupTextByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
DefectCodeGroupTextByKeyFluentHelper
getDefectCodeGroupTextByKey( final String defectCodeGroup, final String language );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectcodeandcodegroup.DefectCodeText
* DefectCodeText} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectcodeandcodegroup.DefectCodeText
* DefectCodeText} 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.defectcodeandcodegroup.DefectCodeTextFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
DefectCodeTextFluentHelper getAllDefectCodeText();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectcodeandcodegroup.DefectCodeText
* DefectCodeText} entity using key fields.
*
* @param defectCode
* Defect Code
*
* Constraints: Not nullable, Maximum length: 4
*
* @param defectCodeGroup
* Defect Code Group
*
* Constraints: Not nullable, Maximum length: 8
*
* @param language
* The language key indicates
*
* Constraints: Not nullable, Maximum length: 2
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectcodeandcodegroup.DefectCodeText
* DefectCodeText} 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.defectcodeandcodegroup.DefectCodeTextByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
DefectCodeTextByKeyFluentHelper
getDefectCodeTextByKey( final String defectCodeGroup, final String defectCode, final String language );
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy