com.sap.cloud.sdk.s4hana.datamodel.odata.services

Interface InspectionPlanService

All Superinterfaces:

BatchService<InspectionPlanServiceBatch>

All Known Implementing Classes:

DefaultInspectionPlanService

public interface InspectionPlanService
extends BatchService<InspectionPlanServiceBatch>

This service enables you to create, read, update, and delete inspection plans in the SAP S/4HANA Cloud system. Inspection plans help you to describe how a quality inspection of one or several materials is to take place.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_INSPECTIONPLAN_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:	InspectionPlan

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SERVICE_PATH If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

Method Summary

Modifier and Type	Method and Description
InspectionPlanCreateFluentHelper	createInspectionPlan(InspectionPlan inspectionPlan) Create a new InspectionPlan entity and save it to the S/4HANA system.
InspPlanMaterialAssgmtCreateFluentHelper	createInspPlanMaterialAssgmt(InspPlanMaterialAssgmt inspPlanMaterialAssgmt) Create a new InspPlanMaterialAssgmt entity and save it to the S/4HANA system.
InspPlanOpCharacteristicCreateFluentHelper	createInspPlanOpCharacteristic(InspPlanOpCharacteristic inspPlanOpCharacteristic) Create a new InspPlanOpCharacteristic entity and save it to the S/4HANA system.
InspPlanOperationCreateFluentHelper	createInspPlanOperation(InspPlanOperation inspPlanOperation) Create a new InspPlanOperation entity and save it to the S/4HANA system.
InspectionPlanDeleteFluentHelper	deleteInspectionPlan(InspectionPlan inspectionPlan) Deletes an existing InspectionPlan entity in the S/4HANA system.
InspPlanMaterialAssgmtDeleteFluentHelper	deleteInspPlanMaterialAssgmt(InspPlanMaterialAssgmt inspPlanMaterialAssgmt) Deletes an existing InspPlanMaterialAssgmt entity in the S/4HANA system.
InspPlanOpCharacteristicDeleteFluentHelper	deleteInspPlanOpCharacteristic(InspPlanOpCharacteristic inspPlanOpCharacteristic) Deletes an existing InspPlanOpCharacteristic entity in the S/4HANA system.
InspPlanOperationDeleteFluentHelper	deleteInspPlanOperation(InspPlanOperation inspPlanOperation) Deletes an existing InspPlanOperation entity in the S/4HANA system.
InspectionPlanFluentHelper	getAllInspectionPlan() Fetch multiple InspectionPlan entities.
InspPlanMaterialAssgmtFluentHelper	getAllInspPlanMaterialAssgmt() Fetch multiple InspPlanMaterialAssgmt entities.
InspPlanOpCharacteristicFluentHelper	getAllInspPlanOpCharacteristic() Fetch multiple InspPlanOpCharacteristic entities.
InspPlanOperationFluentHelper	getAllInspPlanOperation() Fetch multiple InspPlanOperation entities.
InspectionPlanByKeyFluentHelper	getInspectionPlanByKey(String inspectionPlanGroup, String inspectionPlan, String inspectionPlanInternalVersion) Fetch a single InspectionPlan entity using key fields.
InspPlanMaterialAssgmtByKeyFluentHelper	getInspPlanMaterialAssgmtByKey(String material, String plant, String inspectionPlanGroup, String inspectionPlan, String inspPlanMatlAssignment, String inspPlanMatlAssgmtIntVersion) Fetch a single InspPlanMaterialAssgmt entity using key fields.
InspPlanOpCharacteristicByKeyFluentHelper	getInspPlanOpCharacteristicByKey(String inspectionPlanGroup, String bOOOperationInternalID, String bOOCharacteristic, String bOOCharacteristicVersion, String bOOOpInternalVersionCounter, String inspectionPlanInternalVersion, String inspectionPlan) Fetch a single InspPlanOpCharacteristic entity using key fields.
InspPlanOperationByKeyFluentHelper	getInspPlanOperationByKey(String inspectionPlanGroup, String bOOOperationInternalID, String inspectionPlanInternalVersion, String bOOOpInternalVersionCounter, String inspectionPlan) Fetch a single InspPlanOperation entity using key fields.
InspectionPlanUpdateFluentHelper	updateInspectionPlan(InspectionPlan inspectionPlan) Update an existing InspectionPlan entity and save it to the S/4HANA system.
InspPlanMaterialAssgmtUpdateFluentHelper	updateInspPlanMaterialAssgmt(InspPlanMaterialAssgmt inspPlanMaterialAssgmt) Update an existing InspPlanMaterialAssgmt entity and save it to the S/4HANA system.
InspPlanOpCharacteristicUpdateFluentHelper	updateInspPlanOpCharacteristic(InspPlanOpCharacteristic inspPlanOpCharacteristic) Update an existing InspPlanOpCharacteristic entity and save it to the S/4HANA system.
InspPlanOperationUpdateFluentHelper	updateInspPlanOperation(InspPlanOperation inspPlanOperation) Update an existing InspPlanOperation entity and save it to the S/4HANA system.
InspectionPlanService	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.helper.batch.BatchService

batch

Field Detail

DEFAULT_SERVICE_PATH

static final String DEFAULT_SERVICE_PATH

If no other path was provided via the withServicePath(String) method, this is the default service path used to access the endpoint.

See Also:

Constant Field Values

Method Detail

withServicePath

@Nonnull
InspectionPlanService withServicePath(@Nonnull
                                               String servicePath)

Overrides the default service path and returns a new service instance with the specified service path. Also adjusts the respective entity URLs.

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

getAllInspectionPlan

@Nonnull
InspectionPlanFluentHelper getAllInspectionPlan()

Fetch multiple InspectionPlan entities.

Returns:

A fluent helper to fetch multiple InspectionPlan entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getInspectionPlanByKey

@Nonnull
InspectionPlanByKeyFluentHelper getInspectionPlanByKey(String inspectionPlanGroup,
                                                                String inspectionPlan,
                                                                String inspectionPlanInternalVersion)

Fetch a single InspectionPlan entity using key fields.

Parameters:

inspectionPlan - This key and the task list group uniquely identify a task list.

Constraints: Not nullable, Maximum length: 2

inspectionPlanInternalVersion - Identifies the activity posting.

Constraints: Not nullable, Maximum length: 8

inspectionPlanGroup - Key identifying a group.

Constraints: Not nullable, Maximum length: 8

Returns:

A fluent helper to fetch a single InspectionPlan 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 execute method on the fluent helper object.

createInspectionPlan

@Nonnull
InspectionPlanCreateFluentHelper createInspectionPlan(@Nonnull
                                                               InspectionPlan inspectionPlan)

Create a new InspectionPlan entity and save it to the S/4HANA system.

Parameters:

inspectionPlan - InspectionPlan entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new InspectionPlan entity. To perform execution, call the execute method on the fluent helper object.

updateInspectionPlan

@Nonnull
InspectionPlanUpdateFluentHelper updateInspectionPlan(@Nonnull
                                                               InspectionPlan inspectionPlan)

Update an existing InspectionPlan entity and save it to the S/4HANA system.

Parameters:

inspectionPlan - InspectionPlan entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing InspectionPlan entity. To perform execution, call the execute method on the fluent helper object.

deleteInspectionPlan

@Nonnull
InspectionPlanDeleteFluentHelper deleteInspectionPlan(@Nonnull
                                                               InspectionPlan inspectionPlan)

Deletes an existing InspectionPlan entity in the S/4HANA system.

Parameters:

inspectionPlan - InspectionPlan entity object that will be deleted in the S/4HANA system.

Returns:

A fluent helper to delete an existing InspectionPlan entity. To perform execution, call the execute method on the fluent helper object.

getAllInspPlanMaterialAssgmt

@Nonnull
InspPlanMaterialAssgmtFluentHelper getAllInspPlanMaterialAssgmt()

Fetch multiple InspPlanMaterialAssgmt entities.

Returns:

A fluent helper to fetch multiple InspPlanMaterialAssgmt entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getInspPlanMaterialAssgmtByKey

@Nonnull
InspPlanMaterialAssgmtByKeyFluentHelper getInspPlanMaterialAssgmtByKey(String material,
                                                                                String plant,
                                                                                String inspectionPlanGroup,
                                                                                String inspectionPlan,
                                                                                String inspPlanMatlAssignment,
                                                                                String inspPlanMatlAssgmtIntVersion)

Fetch a single InspPlanMaterialAssgmt entity using key fields.

Parameters:

material - Alphanumeric key uniquely identifying the material.

Constraints: Not nullable, Maximum length: 40

inspPlanMatlAssignment - Counter for additional criteria

Constraints: Not nullable, Maximum length: 7

inspPlanMatlAssgmtIntVersion - Identifies the activity posting.

Constraints: Not nullable, Maximum length: 8

plant - Key uniquely identifying a plant.

Constraints: Not nullable, Maximum length: 4

inspectionPlan - This key and the task list group uniquely identify a task list.

Constraints: Not nullable, Maximum length: 2

inspectionPlanGroup - Key identifying a group.

Constraints: Not nullable, Maximum length: 8

Returns:

A fluent helper to fetch a single InspPlanMaterialAssgmt 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 execute method on the fluent helper object.

createInspPlanMaterialAssgmt

@Nonnull
InspPlanMaterialAssgmtCreateFluentHelper createInspPlanMaterialAssgmt(@Nonnull
                                                                               InspPlanMaterialAssgmt inspPlanMaterialAssgmt)

Create a new InspPlanMaterialAssgmt entity and save it to the S/4HANA system.

Parameters:

inspPlanMaterialAssgmt - InspPlanMaterialAssgmt entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new InspPlanMaterialAssgmt entity. To perform execution, call the execute method on the fluent helper object.

updateInspPlanMaterialAssgmt

@Nonnull
InspPlanMaterialAssgmtUpdateFluentHelper updateInspPlanMaterialAssgmt(@Nonnull
                                                                               InspPlanMaterialAssgmt inspPlanMaterialAssgmt)

Update an existing InspPlanMaterialAssgmt entity and save it to the S/4HANA system.

Parameters:

inspPlanMaterialAssgmt - InspPlanMaterialAssgmt entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing InspPlanMaterialAssgmt entity. To perform execution, call the execute method on the fluent helper object.

deleteInspPlanMaterialAssgmt

@Nonnull
InspPlanMaterialAssgmtDeleteFluentHelper deleteInspPlanMaterialAssgmt(@Nonnull
                                                                               InspPlanMaterialAssgmt inspPlanMaterialAssgmt)

Deletes an existing InspPlanMaterialAssgmt entity in the S/4HANA system.

Parameters:

inspPlanMaterialAssgmt - InspPlanMaterialAssgmt entity object that will be deleted in the S/4HANA system.

Returns:

A fluent helper to delete an existing InspPlanMaterialAssgmt entity. To perform execution, call the execute method on the fluent helper object.

getAllInspPlanOpCharacteristic

@Nonnull
InspPlanOpCharacteristicFluentHelper getAllInspPlanOpCharacteristic()

Fetch multiple InspPlanOpCharacteristic entities.

Returns:

A fluent helper to fetch multiple InspPlanOpCharacteristic entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getInspPlanOpCharacteristicByKey

@Nonnull
InspPlanOpCharacteristicByKeyFluentHelper getInspPlanOpCharacteristicByKey(String inspectionPlanGroup,
                                                                                    String bOOOperationInternalID,
                                                                                    String bOOCharacteristic,
                                                                                    String bOOCharacteristicVersion,
                                                                                    String bOOOpInternalVersionCounter,
                                                                                    String inspectionPlanInternalVersion,
                                                                                    String inspectionPlan)

Fetch a single InspPlanOpCharacteristic entity using key fields.

Parameters:

bOOOperationInternalID - Number of the Task List Node

Constraints: Not nullable, Maximum length: 8

bOOCharacteristic - The number that explicitly identifies an inspection characteristic within an operation in an inspection plan.

Constraints: Not nullable, Maximum length: 4

bOOCharacteristicVersion - Identifies the activity posting.

Constraints: Not nullable, Maximum length: 8

inspectionPlan - This key and the task list group uniquely identify a task list.

Constraints: Not nullable, Maximum length: 2

inspectionPlanInternalVersion - Identifies the activity posting.

Constraints: Not nullable, Maximum length: 8

inspectionPlanGroup - Key identifying a group.

Constraints: Not nullable, Maximum length: 8

bOOOpInternalVersionCounter - Identifies the activity posting.

Constraints: Not nullable, Maximum length: 8

Returns:

A fluent helper to fetch a single InspPlanOpCharacteristic 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 execute method on the fluent helper object.

createInspPlanOpCharacteristic

@Nonnull
InspPlanOpCharacteristicCreateFluentHelper createInspPlanOpCharacteristic(@Nonnull
                                                                                   InspPlanOpCharacteristic inspPlanOpCharacteristic)

Create a new InspPlanOpCharacteristic entity and save it to the S/4HANA system.

Parameters:

inspPlanOpCharacteristic - InspPlanOpCharacteristic entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new InspPlanOpCharacteristic entity. To perform execution, call the execute method on the fluent helper object.

updateInspPlanOpCharacteristic

@Nonnull
InspPlanOpCharacteristicUpdateFluentHelper updateInspPlanOpCharacteristic(@Nonnull
                                                                                   InspPlanOpCharacteristic inspPlanOpCharacteristic)

Update an existing InspPlanOpCharacteristic entity and save it to the S/4HANA system.

Parameters:

inspPlanOpCharacteristic - InspPlanOpCharacteristic entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing InspPlanOpCharacteristic entity. To perform execution, call the execute method on the fluent helper object.

deleteInspPlanOpCharacteristic

@Nonnull
InspPlanOpCharacteristicDeleteFluentHelper deleteInspPlanOpCharacteristic(@Nonnull
                                                                                   InspPlanOpCharacteristic inspPlanOpCharacteristic)

Deletes an existing InspPlanOpCharacteristic entity in the S/4HANA system.

Parameters:

inspPlanOpCharacteristic - InspPlanOpCharacteristic entity object that will be deleted in the S/4HANA system.

Returns:

A fluent helper to delete an existing InspPlanOpCharacteristic entity. To perform execution, call the execute method on the fluent helper object.

getAllInspPlanOperation

@Nonnull
InspPlanOperationFluentHelper getAllInspPlanOperation()

Fetch multiple InspPlanOperation entities.

Returns:

A fluent helper to fetch multiple InspPlanOperation entities. This fluent helper allows methods which modify the underlying query to be called before executing the query itself. To perform execution, call the execute method on the fluent helper object.

getInspPlanOperationByKey

@Nonnull
InspPlanOperationByKeyFluentHelper getInspPlanOperationByKey(String inspectionPlanGroup,
                                                                      String bOOOperationInternalID,
                                                                      String inspectionPlanInternalVersion,
                                                                      String bOOOpInternalVersionCounter,
                                                                      String inspectionPlan)

Fetch a single InspPlanOperation entity using key fields.

Parameters:

bOOOperationInternalID - Number of the Task List Node

Constraints: Not nullable, Maximum length: 8

inspectionPlan - This key and the task list group uniquely identify a task list.

Constraints: Not nullable, Maximum length: 2

inspectionPlanInternalVersion - Identifies the activity posting.

Constraints: Not nullable, Maximum length: 8

inspectionPlanGroup - Key identifying a group.

Constraints: Not nullable, Maximum length: 8

bOOOpInternalVersionCounter - Identifies the activity posting.

Constraints: Not nullable, Maximum length: 8

Returns:

A fluent helper to fetch a single InspPlanOperation 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 execute method on the fluent helper object.

createInspPlanOperation

@Nonnull
InspPlanOperationCreateFluentHelper createInspPlanOperation(@Nonnull
                                                                     InspPlanOperation inspPlanOperation)

Create a new InspPlanOperation entity and save it to the S/4HANA system.

Parameters:

inspPlanOperation - InspPlanOperation entity object that will be created in the S/4HANA system.

Returns:

A fluent helper to create a new InspPlanOperation entity. To perform execution, call the execute method on the fluent helper object.

updateInspPlanOperation

@Nonnull
InspPlanOperationUpdateFluentHelper updateInspPlanOperation(@Nonnull
                                                                     InspPlanOperation inspPlanOperation)

Update an existing InspPlanOperation entity and save it to the S/4HANA system.

Parameters:

inspPlanOperation - InspPlanOperation entity object that will be updated in the S/4HANA system.

Returns:

A fluent helper to update an existing InspPlanOperation entity. To perform execution, call the execute method on the fluent helper object.

deleteInspPlanOperation

@Nonnull
InspPlanOperationDeleteFluentHelper deleteInspPlanOperation(@Nonnull
                                                                     InspPlanOperation inspPlanOperation)

Deletes an existing InspPlanOperation entity in the S/4HANA system.

Parameters:

inspPlanOperation - InspPlanOperation entity object that will be deleted in the S/4HANA system.

Returns:

A fluent helper to delete an existing InspPlanOperation entity. To perform execution, call the execute method on the fluent helper object.