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

Interface ProcessOrderConfirmationV2Service

All Superinterfaces:

BatchService<ProcessOrderConfirmationV2ServiceBatch>

All Known Implementing Classes:

DefaultProcessOrderConfirmationV2Service

public interface ProcessOrderConfirmationV2Service
extends BatchService<ProcessOrderConfirmationV2ServiceBatch>

You can create time ticket confirmations and confirmations on order level, read them, and cancel the confirmations on time ticket or order level.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_PROC_ORDER_CONFIRMATION_2_SRV
API Version:	2
Communication Scenario:	Production Planning Integration (SAP_COM_0104), Manufacturing Execution - Order and Confirmation Integration (SAP_COM_0522)
Scope Items:	Make-to-Stock Production - Discrete Manufacturing (BJ5), Make-to-Stock - Process Manufacturing Based on Process Order (BJ8), Material Requirements Planning (J44), Third-Party Shop Floor Execution - Process Industry (3W3), Third-Party Shop Floor Execution - Discrete Industry (3W4)
Authentication Methods:	Basic, x509
Business Object:	ProcessOrder

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
CancelProcOrdConfFluentHelper	cancelProcOrdConf(String confirmationGroup, String confirmationCount, LocalDateTime postingDate, String confirmationText, UUID externalSystemConfirmation) Creates a fluent helper for the CancelProcOrdConf OData function import.
ProcOrdConf2CreateFluentHelper	createProcOrdConf2(ProcOrdConf2 procOrdConf2) Create a new ProcOrdConf2 entity and save it to the S/4HANA system.
ProcOrdConfMatlDocItmCreateFluentHelper	createProcOrdConfMatlDocItm(ProcOrdConfMatlDocItm procOrdConfMatlDocItm) Create a new ProcOrdConfMatlDocItm entity and save it to the S/4HANA system.
ProcOrdConf2FluentHelper	getAllProcOrdConf2() Fetch multiple ProcOrdConf2 entities.
ProcOrdConfMatlDocItmFluentHelper	getAllProcOrdConfMatlDocItm() Fetch multiple ProcOrdConfMatlDocItm entities.
ProcOrdConf2ByKeyFluentHelper	getProcOrdConf2ByKey(String confirmationGroup, String confirmationCount) Fetch a single ProcOrdConf2 entity using key fields.
ProcOrdConfMatlDocItmByKeyFluentHelper	getProcOrdConfMatlDocItmByKey(String confirmationGroup, String confirmationCount, String materialDocument, String materialDocumentItem, String materialDocumentYear) Fetch a single ProcOrdConfMatlDocItm entity using key fields.
ProcessOrderConfirmationV2Service	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
ProcessOrderConfirmationV2Service 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.

getAllProcOrdConf2

@Nonnull
ProcOrdConf2FluentHelper getAllProcOrdConf2()

Fetch multiple ProcOrdConf2 entities.

Returns:

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

getProcOrdConf2ByKey

@Nonnull
ProcOrdConf2ByKeyFluentHelper getProcOrdConf2ByKey(String confirmationGroup,
                                                            String confirmationCount)

Fetch a single ProcOrdConf2 entity using key fields.

Parameters:

confirmationCount - Identifier of Single Order Confirmation

Constraints: Not nullable, Maximum length: 8

confirmationGroup - Collective ID of Order Confirmations

Constraints: Not nullable, Maximum length: 10

Returns:

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

createProcOrdConf2

@Nonnull
ProcOrdConf2CreateFluentHelper createProcOrdConf2(@Nonnull
                                                           ProcOrdConf2 procOrdConf2)

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

Parameters:

procOrdConf2 - ProcOrdConf2 entity object that will be created in the S/4HANA system.

Returns:

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

getAllProcOrdConfMatlDocItm

@Nonnull
ProcOrdConfMatlDocItmFluentHelper getAllProcOrdConfMatlDocItm()

Fetch multiple ProcOrdConfMatlDocItm entities.

Returns:

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

getProcOrdConfMatlDocItmByKey

@Nonnull
ProcOrdConfMatlDocItmByKeyFluentHelper getProcOrdConfMatlDocItmByKey(String confirmationGroup,
                                                                              String confirmationCount,
                                                                              String materialDocument,
                                                                              String materialDocumentItem,
                                                                              String materialDocumentYear)

Fetch a single ProcOrdConfMatlDocItm entity using key fields.

Parameters:

materialDocument - Alphanumeric key uniquely identifying the document.

Constraints: Not nullable, Maximum length: 10

confirmationCount - Identifier of Single Order Confirmation

Constraints: Not nullable, Maximum length: 8

materialDocumentItem - Specifies the number that uniquely identifies an item in .

Constraints: Not nullable, Maximum length: 4

materialDocumentYear - Calendar year in which the material document was posted.

Constraints: Not nullable, Maximum length: 4

confirmationGroup - Collective ID of Order Confirmations

Constraints: Not nullable, Maximum length: 10

Returns:

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

createProcOrdConfMatlDocItm

@Nonnull
ProcOrdConfMatlDocItmCreateFluentHelper createProcOrdConfMatlDocItm(@Nonnull
                                                                             ProcOrdConfMatlDocItm procOrdConfMatlDocItm)

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

Parameters:

procOrdConfMatlDocItm - ProcOrdConfMatlDocItm entity object that will be created in the S/4HANA system.

Returns:

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

cancelProcOrdConf

@Nonnull
CancelProcOrdConfFluentHelper cancelProcOrdConf(String confirmationGroup,
                                                         String confirmationCount,
                                                         LocalDateTime postingDate,
                                                         String confirmationText,
                                                         UUID externalSystemConfirmation)

Creates a fluent helper for the CancelProcOrdConf OData function import.

Parameters:

externalSystemConfirmation - External Key

Constraints: Nullable

Original parameter name from the Odata EDM: ExternalSystemConfirmation

confirmationCount - Order Confirmation

Constraints: Not nullable, Maximum length: 8

Original parameter name from the Odata EDM: ConfirmationCount

confirmationText - Confirmation Text

Constraints: Nullable, Maximum length: 40

Original parameter name from the Odata EDM: ConfirmationText

postingDate - Posting Date

Constraints: Nullable, Precision: 0

Original parameter name from the Odata EDM: PostingDate

confirmationGroup - Confirmation Group

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: ConfirmationGroup

Returns:

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