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

Class DefaultProcessOrderConfirmationV2Service

java.lang.Object

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

All Implemented Interfaces:

BatchService<ProcessOrderConfirmationV2ServiceBatch>, ProcessOrderConfirmationV2Service

@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultProcessOrderConfirmationV2Service")
public class DefaultProcessOrderConfirmationV2Service
extends Object
implements ProcessOrderConfirmationV2Service

This synchronous inbound service enables you to create header and time ticket confirmations, read confirmations, and cancel confirmations for process orders.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_PROC_ORDER_CONFIRMATION_2_SRV
API Version:	1
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), Integration of Third Party MES for Discrete Industry (3W4)
Authentication Methods:	Basic, x509
Business Object:	ProcessOrder

Field Summary

Fields inherited from interface com.sap.cloud.sdk.s4hana.datamodel.odata.services.ProcessOrderConfirmationV2Service

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultProcessOrderConfirmationV2Service() Creates a service using ProcessOrderConfirmationV2Service.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
DefaultProcessOrderConfirmationV2ServiceBatch	batch() Instantiate a new FluentHelper instance for a single OData batch request.
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.
DefaultProcessOrderConfirmationV2Service	withServicePath(String servicePath) Overrides the default service path and returns a new service instance with the specified service path.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultProcessOrderConfirmationV2Service

public DefaultProcessOrderConfirmationV2Service()

Creates a service using ProcessOrderConfirmationV2Service.DEFAULT_SERVICE_PATH to send the requests.

Method Detail

withServicePath

@Nonnull
public DefaultProcessOrderConfirmationV2Service withServicePath(@Nonnull
                                                                         String servicePath)

Description copied from interface: ProcessOrderConfirmationV2Service

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

Specified by:

withServicePath in interface ProcessOrderConfirmationV2Service

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path.

batch

@Nonnull
public DefaultProcessOrderConfirmationV2ServiceBatch batch()

Instantiate a new FluentHelper instance for a single OData batch request.

Specified by:

batch in interface BatchService<ProcessOrderConfirmationV2ServiceBatch>

Returns:

A new instance of an OData batch request associated with the service object.

getAllProcOrdConf2

@Nonnull
public ProcOrdConf2FluentHelper getAllProcOrdConf2()

Description copied from interface: ProcessOrderConfirmationV2Service

Fetch multiple ProcOrdConf2 entities.

Specified by:

getAllProcOrdConf2 in interface ProcessOrderConfirmationV2Service

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
public ProcOrdConf2ByKeyFluentHelper getProcOrdConf2ByKey(String confirmationGroup,
                                                                   String confirmationCount)

Description copied from interface: ProcessOrderConfirmationV2Service

Fetch a single ProcOrdConf2 entity using key fields.

Specified by:

getProcOrdConf2ByKey in interface ProcessOrderConfirmationV2Service

Parameters:

confirmationGroup - Collective ID of Order Confirmations

Constraints: Not nullable, Maximum length: 10

confirmationCount - Identifier of Single Order Confirmation

Constraints: Not nullable, Maximum length: 8

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
public ProcOrdConf2CreateFluentHelper createProcOrdConf2(@Nonnull
                                                                  ProcOrdConf2 procOrdConf2)

Description copied from interface: ProcessOrderConfirmationV2Service

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

Specified by:

createProcOrdConf2 in interface ProcessOrderConfirmationV2Service

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
public ProcOrdConfMatlDocItmFluentHelper getAllProcOrdConfMatlDocItm()

Description copied from interface: ProcessOrderConfirmationV2Service

Fetch multiple ProcOrdConfMatlDocItm entities.

Specified by:

getAllProcOrdConfMatlDocItm in interface ProcessOrderConfirmationV2Service

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
public ProcOrdConfMatlDocItmByKeyFluentHelper getProcOrdConfMatlDocItmByKey(String confirmationGroup,
                                                                                     String confirmationCount,
                                                                                     String materialDocument,
                                                                                     String materialDocumentItem,
                                                                                     String materialDocumentYear)

Description copied from interface: ProcessOrderConfirmationV2Service

Fetch a single ProcOrdConfMatlDocItm entity using key fields.

Specified by:

getProcOrdConfMatlDocItmByKey in interface ProcessOrderConfirmationV2Service

Parameters:

confirmationGroup - Collective ID of Order Confirmations

Constraints: Not nullable, Maximum length: 10

confirmationCount - Identifier of Single Order Confirmation

Constraints: Not nullable, Maximum length: 8

materialDocument - Alphanumeric key uniquely identifying the document.

Constraints: Not nullable, Maximum length: 10

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

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
public ProcOrdConfMatlDocItmCreateFluentHelper createProcOrdConfMatlDocItm(@Nonnull
                                                                                    ProcOrdConfMatlDocItm procOrdConfMatlDocItm)

Description copied from interface: ProcessOrderConfirmationV2Service

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

Specified by:

createProcOrdConfMatlDocItm in interface ProcessOrderConfirmationV2Service

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
public CancelProcOrdConfFluentHelper cancelProcOrdConf(String confirmationGroup,
                                                                String confirmationCount,
                                                                LocalDateTime postingDate,
                                                                String confirmationText,
                                                                UUID externalSystemConfirmation)

Description copied from interface: ProcessOrderConfirmationV2Service

Creates a fluent helper for the CancelProcOrdConf OData function import.

Specified by:

cancelProcOrdConf in interface ProcessOrderConfirmationV2Service

Parameters:

confirmationGroup - Confirmation Group

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: ConfirmationGroup

confirmationCount - Order Confirmation

Constraints: Not nullable, Maximum length: 8

Original parameter name from the Odata EDM: ConfirmationCount

postingDate - Posting Date

Constraints: Nullable, Precision: 0

Original parameter name from the Odata EDM: PostingDate

confirmationText - Confirmation Text

Constraints: Nullable, Maximum length: 40

Original parameter name from the Odata EDM: ConfirmationText

externalSystemConfirmation - External Key

Constraints: Nullable

Original parameter name from the Odata EDM: ExternalSystemConfirmation

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.