com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefectProcessingService 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.defectprocessing.Defect;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectprocessing.DefectByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectprocessing.DefectCreateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectprocessing.DefectDeleteFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectprocessing.DefectFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectprocessing.DefectUpdateFluentHelper;
/**
*
* This service enables you to create, read, update, and delete defects that are not assigned to a quality notification.
* A defect is a deviation due to which a requirement cannot be fulfilled (for example, encountered during a quality
* inspection).
*
*
*
* Reference:
* SAP
* API Business Hub
*
* Details:
*
*
* OData Service:
* API_DEFECT_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 DefectProcessingService
{
/**
* 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_DEFECT_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
DefectProcessingService withServicePath( @Nonnull final String servicePath );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectprocessing.Defect Defect}
* entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectprocessing.Defect Defect} 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.defectprocessing.DefectFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
DefectFluentHelper getAllDefect();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectprocessing.Defect Defect} entity
* using key fields.
*
* @param defectInternalID
* Number that identifies the notification.
*
* Constraints: Not nullable, Maximum length: 12
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectprocessing.Defect Defect} 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.defectprocessing.DefectByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
DefectByKeyFluentHelper getDefectByKey( final String defectInternalID );
/**
* Create a new {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectprocessing.Defect Defect} entity
* and save it to the S/4HANA system.
*
* @param defect
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectprocessing.Defect Defect} entity
* object that will be created in the S/4HANA system.
* @return A fluent helper to create a new
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectprocessing.Defect Defect} entity. To
* perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectprocessing.DefectCreateFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
DefectCreateFluentHelper createDefect( @Nonnull final Defect defect );
/**
* Update an existing {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectprocessing.Defect Defect}
* entity and save it to the S/4HANA system.
*
* @param defect
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectprocessing.Defect Defect} entity
* object that will be updated in the S/4HANA system.
* @return A fluent helper to update an existing
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectprocessing.Defect Defect} entity. To
* perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectprocessing.DefectUpdateFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
DefectUpdateFluentHelper updateDefect( @Nonnull final Defect defect );
/**
* Deletes an existing {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectprocessing.Defect Defect}
* entity in the S/4HANA system.
*
* @param defect
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectprocessing.Defect Defect} entity
* object that will be deleted in the S/4HANA system.
* @return A fluent helper to delete an existing
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectprocessing.Defect Defect} entity. To
* perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.defectprocessing.DefectDeleteFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
DefectDeleteFluentHelper deleteDefect( @Nonnull final Defect defect );
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy