
com.sap.cloud.sdk.s4hana.datamodel.odata.services.QualityInspectionDataService 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.helper.batch.BatchService;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspLotUsageDecision;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspLotUsageDecisionByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspLotUsageDecisionCreateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspLotUsageDecisionFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspLotUsageDecisionUpdateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionCharacteristicByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionCharacteristicFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionLot;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionLotByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionLotFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionLotUpdateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionLotWithStatusByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionLotWithStatusFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionOperationByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionOperationFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionResult;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionResultByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionResultCreateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionResultFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionResultUpdateFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionResultValueByKeyFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionResultValueFluentHelper;
import com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.batch.QualityInspectionDataServiceBatch;
/**
*
* This service enables you to read quality inspection data, for example, inspection lots, inspection operations,
* inspection characteristics, inspection results, and usage decisions. In addition, it enables you to update inspection
* lots, create and update usage decisions and create and update summarized inspection results.
*
*
*
* Reference: SAP API
* Business Hub
*
* Details:
*
*
* OData Service:
* API_INSPECTIONLOT_SRV
*
*
* API Version:
* 1
*
*
* Communication Scenario:
* Quality Inspection Process Integration (SAP_COM_0318)
*
*
* Scope Items:
* Quality Management in Discrete Manufacturing (1E1),
* Quality Management in Procurement (1FM),
* Quality Management in Sales (1MP),
* Quality Management in Stock Handling (1MR)
*
*
* Authentication Methods:
* Basic, x509, OAuth2
*
*
* Business Object:
* InspectionLot
*
*
*
*/
public interface QualityInspectionDataService 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_INSPECTIONLOT_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
QualityInspectionDataService withServicePath( @Nonnull final String servicePath );
/**
* Fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionCharacteristic
* InspectionCharacteristic} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionCharacteristic
* InspectionCharacteristic} 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.qualityinspectiondata.InspectionCharacteristicFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
InspectionCharacteristicFluentHelper getAllInspectionCharacteristic();
/**
* Fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionCharacteristic
* InspectionCharacteristic} entity using key fields.
*
* @param inspPlanOperationInternalID
* Current Node Number from Order Counter
*
* Constraints: Not nullable, Maximum length: 8
*
* @param inspectionCharacteristic
* The number that explicitly identifies an inspection characteristic within an operation in an
* inspection plan.
*
* Constraints: Not nullable, Maximum length: 4
*
* @param inspectionLot
* Number that uniquely identifies an inspection lot.
*
* Constraints: Not nullable, Maximum length: 12
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionCharacteristic
* InspectionCharacteristic} 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.qualityinspectiondata.InspectionCharacteristicByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
InspectionCharacteristicByKeyFluentHelper getInspectionCharacteristicByKey(
final String inspectionLot,
final String inspPlanOperationInternalID,
final String inspectionCharacteristic );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionLot
* InspectionLot} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionLot
* InspectionLot} 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.qualityinspectiondata.InspectionLotFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
InspectionLotFluentHelper getAllInspectionLot();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionLot
* InspectionLot} entity using key fields.
*
* @param inspectionLot
* Number that uniquely identifies an inspection lot.
*
* Constraints: Not nullable, Maximum length: 12
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionLot
* InspectionLot} 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.qualityinspectiondata.InspectionLotByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
InspectionLotByKeyFluentHelper getInspectionLotByKey( final String inspectionLot );
/**
* Update an existing {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionLot
* InspectionLot} entity and save it to the S/4HANA system.
*
* @param inspectionLot
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionLot
* InspectionLot} 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.qualityinspectiondata.InspectionLot
* InspectionLot} entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionLotUpdateFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
InspectionLotUpdateFluentHelper updateInspectionLot( @Nonnull final InspectionLot inspectionLot );
/**
* Fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionLotWithStatus
* InspectionLotWithStatus} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionLotWithStatus
* InspectionLotWithStatus} 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.qualityinspectiondata.InspectionLotWithStatusFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
InspectionLotWithStatusFluentHelper getAllInspectionLotWithStatus();
/**
* Fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionLotWithStatus
* InspectionLotWithStatus} entity using key fields.
*
* @param inspectionLot
* Number that uniquely identifies an inspection lot.
*
* Constraints: Not nullable, Maximum length: 12
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionLotWithStatus
* InspectionLotWithStatus} 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.qualityinspectiondata.InspectionLotWithStatusByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
InspectionLotWithStatusByKeyFluentHelper getInspectionLotWithStatusByKey( final String inspectionLot );
/**
* Fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionOperation
* InspectionOperation} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionOperation
* InspectionOperation} 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.qualityinspectiondata.InspectionOperationFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
InspectionOperationFluentHelper getAllInspectionOperation();
/**
* Fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionOperation
* InspectionOperation} entity using key fields.
*
* @param inspPlanOperationInternalID
* Current Node Number from Order Counter
*
* Constraints: Not nullable, Maximum length: 8
*
* @param inspectionLot
* Number that uniquely identifies an inspection lot.
*
* Constraints: Not nullable, Maximum length: 12
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionOperation
* InspectionOperation} 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.qualityinspectiondata.InspectionOperationByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
InspectionOperationByKeyFluentHelper
getInspectionOperationByKey( final String inspectionLot, final String inspPlanOperationInternalID );
/**
* Fetch multiple {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionResult
* InspectionResult} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionResult
* InspectionResult} 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.qualityinspectiondata.InspectionResultFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
InspectionResultFluentHelper getAllInspectionResult();
/**
* Fetch a single {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionResult
* InspectionResult} entity using key fields.
*
* @param inspPlanOperationInternalID
* Current Node Number from Order Counter
*
* Constraints: Not nullable, Maximum length: 8
*
* @param inspectionCharacteristic
* The number that explicitly identifies an inspection characteristic within an operation in an
* inspection plan.
*
* Constraints: Not nullable, Maximum length: 4
*
* @param inspectionLot
* Number that uniquely identifies an inspection lot.
*
* Constraints: Not nullable, Maximum length: 12
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionResult
* InspectionResult} 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.qualityinspectiondata.InspectionResultByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
InspectionResultByKeyFluentHelper getInspectionResultByKey(
final String inspectionLot,
final String inspPlanOperationInternalID,
final String inspectionCharacteristic );
/**
* Create a new {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionResult
* InspectionResult} entity and save it to the S/4HANA system.
*
* @param inspectionResult
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionResult
* InspectionResult} 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.qualityinspectiondata.InspectionResult
* InspectionResult} entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionResultCreateFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
InspectionResultCreateFluentHelper createInspectionResult( @Nonnull final InspectionResult inspectionResult );
/**
* Update an existing
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionResult
* InspectionResult} entity and save it to the S/4HANA system.
*
* @param inspectionResult
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionResult
* InspectionResult} 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.qualityinspectiondata.InspectionResult
* InspectionResult} entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionResultUpdateFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
InspectionResultUpdateFluentHelper updateInspectionResult( @Nonnull final InspectionResult inspectionResult );
/**
* Fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionResultValue
* InspectionResultValue} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionResultValue
* InspectionResultValue} 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.qualityinspectiondata.InspectionResultValueFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
InspectionResultValueFluentHelper getAllInspectionResultValue();
/**
* Fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionResultValue
* InspectionResultValue} entity using key fields.
*
* @param inspPlanOperationInternalID
* Current Node Number from Order Counter
*
* Constraints: Not nullable, Maximum length: 8
*
* @param inspectionCharacteristic
* The number that explicitly identifies an inspection characteristic within an operation in an
* inspection plan.
*
* Constraints: Not nullable, Maximum length: 4
*
* @param inspResultValueInternalID
* Number of Individual Result
*
* Constraints: Not nullable, Maximum length: 8
*
* @param inspectionLot
* Number that uniquely identifies an inspection lot.
*
* Constraints: Not nullable, Maximum length: 12
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspectionResultValue
* InspectionResultValue} 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.qualityinspectiondata.InspectionResultValueByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
InspectionResultValueByKeyFluentHelper getInspectionResultValueByKey(
final String inspectionLot,
final String inspPlanOperationInternalID,
final String inspectionCharacteristic,
final String inspResultValueInternalID );
/**
* Fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspLotUsageDecision
* InspLotUsageDecision} entities.
*
* @return A fluent helper to fetch multiple
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspLotUsageDecision
* InspLotUsageDecision} 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.qualityinspectiondata.InspLotUsageDecisionFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
InspLotUsageDecisionFluentHelper getAllInspLotUsageDecision();
/**
* Fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspLotUsageDecision
* InspLotUsageDecision} entity using key fields.
*
* @param inspectionLot
* Number that uniquely identifies an inspection lot.
*
* Constraints: Not nullable, Maximum length: 12
*
* @return A fluent helper to fetch a single
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspLotUsageDecision
* InspLotUsageDecision} 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.qualityinspectiondata.InspLotUsageDecisionByKeyFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
InspLotUsageDecisionByKeyFluentHelper getInspLotUsageDecisionByKey( final String inspectionLot );
/**
* Create a new
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspLotUsageDecision
* InspLotUsageDecision} entity and save it to the S/4HANA system.
*
* @param inspLotUsageDecision
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspLotUsageDecision
* InspLotUsageDecision} 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.qualityinspectiondata.InspLotUsageDecision
* InspLotUsageDecision} entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspLotUsageDecisionCreateFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
InspLotUsageDecisionCreateFluentHelper
createInspLotUsageDecision( @Nonnull final InspLotUsageDecision inspLotUsageDecision );
/**
* Update an existing
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspLotUsageDecision
* InspLotUsageDecision} entity and save it to the S/4HANA system.
*
* @param inspLotUsageDecision
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspLotUsageDecision
* InspLotUsageDecision} 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.qualityinspectiondata.InspLotUsageDecision
* InspLotUsageDecision} entity. To perform execution, call the
* {@link com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.qualityinspectiondata.InspLotUsageDecisionUpdateFluentHelper#execute
* execute} method on the fluent helper object.
*/
@Nonnull
InspLotUsageDecisionUpdateFluentHelper
updateInspLotUsageDecision( @Nonnull final InspLotUsageDecision inspLotUsageDecision );
}