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

Interface MaintenanceOrderOperationConfirmationService

All Superinterfaces:

BatchService<MaintenanceOrderOperationConfirmationServiceBatch>

All Known Implementing Classes:

DefaultMaintenanceOrderOperationConfirmationService

public interface MaintenanceOrderOperationConfirmationService
extends BatchService<MaintenanceOrderOperationConfirmationServiceBatch>

This synchronous inbound service enables you to create new maintenance order confirmations and cancel confirmations that are already posted. You can display and use this data, for example, in an external application. The API is based on the OData V2 protocol..

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_MAINTORDERCONFIRMATION
API Version:	1
Communication Scenario:	Plant Maintenance Execution Integration (SAP_COM_0398)
Scope Items:	Service Order Management and Monitoring (3D2), Service Contract Management (3MO), In-House Repair (3XK), Service Order processing with SAP Field service management (49X), Service Quotation (4GA), Reactive Maintenance (4HH), Proactive Maintenance (4HI), Improvement Maintenance (4VT), Operations and Overhead Maintenance (4WM), Corrective Maintenance (BH1), Emergency Maintenance (BH2), Preventive Maintenance (BJ2)
Authentication Methods:	Basic, x509, OAuth2
Business Object:	MaintenanceOrderConfirmation

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
CancelMaintOrderConfirmationFluentHelper	cancelMaintOrderConfirmation(String maintOrderConf, String maintOrderConfCntrValue) Creates a fluent helper for the CancelMaintOrderConfirmation OData function import.
LongTextCreateFluentHelper	createLongText(LongText longText) Create a new LongText entity and save it to the S/4HANA system.
MaintOrderConfirmationCreateFluentHelper	createMaintOrderConfirmation(MaintOrderConfirmation maintOrderConfirmation) Create a new MaintOrderConfirmation entity and save it to the S/4HANA system.
LongTextFluentHelper	getAllLongText() Fetch multiple LongText entities.
MaintOrderConfirmationFluentHelper	getAllMaintOrderConfirmation() Fetch multiple MaintOrderConfirmation entities.
LongTextByKeyFluentHelper	getLongTextByKey(String maintOrderConf, String maintOrderConfCntrValue) Fetch a single LongText entity using key fields.
MaintOrderConfirmationByKeyFluentHelper	getMaintOrderConfirmationByKey(String maintOrderConf, String maintOrderConfCntrValue) Fetch a single MaintOrderConfirmation entity using key fields.
MaintenanceOrderOperationConfirmationService	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.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
MaintenanceOrderOperationConfirmationService 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.

getAllMaintOrderConfirmation

@Nonnull
MaintOrderConfirmationFluentHelper getAllMaintOrderConfirmation()

Fetch multiple MaintOrderConfirmation entities.

Returns:

A fluent helper to fetch multiple MaintOrderConfirmation 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.

getMaintOrderConfirmationByKey

@Nonnull
MaintOrderConfirmationByKeyFluentHelper getMaintOrderConfirmationByKey(String maintOrderConf,
                                                                                String maintOrderConfCntrValue)

Fetch a single MaintOrderConfirmation entity using key fields.

Parameters:

maintOrderConf - Number used to identify an operation in the confirmation.

Constraints: Not nullable, Maximum length: 10

maintOrderConfCntrValue - Counter that enumerates confirmations for an operation. If more than one confirmation was created for an operation then the confirmation counter together with the confirmation number unambiguously identifies the individual confirmation.

Constraints: Not nullable, Maximum length: 8

Returns:

A fluent helper to fetch a single MaintOrderConfirmation 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.

createMaintOrderConfirmation

@Nonnull
MaintOrderConfirmationCreateFluentHelper createMaintOrderConfirmation(@Nonnull
                                                                               MaintOrderConfirmation maintOrderConfirmation)

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

Parameters:

maintOrderConfirmation - MaintOrderConfirmation entity object that will be created in the S/4HANA system.

Returns:

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

getAllLongText

@Nonnull
LongTextFluentHelper getAllLongText()

Fetch multiple LongText entities.

Returns:

A fluent helper to fetch multiple LongText 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.

getLongTextByKey

@Nonnull
LongTextByKeyFluentHelper getLongTextByKey(String maintOrderConf,
                                                    String maintOrderConfCntrValue)

Fetch a single LongText entity using key fields.

Parameters:

maintOrderConf - Number used to identify an operation in the confirmation.

Constraints: Not nullable, Maximum length: 10

maintOrderConfCntrValue - Counter that enumerates confirmations for an operation. If more than one confirmation was created for an operation then the confirmation counter together with the confirmation number unambiguously identifies the individual confirmation.

Constraints: Not nullable, Maximum length: 8

Returns:

A fluent helper to fetch a single LongText 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.

createLongText

@Nonnull
LongTextCreateFluentHelper createLongText(@Nonnull
                                                   LongText longText)

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

Parameters:

longText - LongText entity object that will be created in the S/4HANA system.

Returns:

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

cancelMaintOrderConfirmation

@Nonnull
CancelMaintOrderConfirmationFluentHelper cancelMaintOrderConfirmation(String maintOrderConf,
                                                                               String maintOrderConfCntrValue)

Creates a fluent helper for the CancelMaintOrderConfirmation OData function import.

Parameters:

maintOrderConf - Confirmation

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: MaintOrderConf

maintOrderConfCntrValue - Counter

Constraints: Not nullable, Maximum length: 8

Original parameter name from the Odata EDM: MaintOrderConfCntrValue

Returns:

A fluent helper object that will execute the CancelMaintOrderConfirmation OData function import with the provided parameters. To perform execution, call the execute method on the fluent helper object.