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

Class DefaultMaterialDocumentService

java.lang.Object

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

All Implemented Interfaces:

MaterialDocumentService

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

This service enables you to retrieve and create material documents, e.g. to post a goods receipt for a purchase order or to document the transfer of materials between two storage locations. Additionally, the service allows to cancel existing material documents or single items. It can be consumed by external systems and user interfaces.

Business Documentation

Reference: SAP API Business Hub

Details:

OData Service:	API_MATERIAL_DOCUMENT_SRV
API Version:	1
Communication Scenario:	Material Document Integration (SAP_COM_0108)
Scope Items:	Stock Handling - Rework, Scrap, Blocked Stock (BMC)

Field Summary

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

DEFAULT_SERVICE_PATH

Constructor Summary

Constructors

Constructor and Description
DefaultMaterialDocumentService() Creates a service using MaterialDocumentService.DEFAULT_SERVICE_PATH to send the requests.

Method Summary

Modifier and Type	Method and Description
CancelFluentHelper	cancel(String materialDocumentYear, String materialDocument, LocalDateTime postingDate) Creates a fluent helper for the Cancel OData function import.
CancelItemFluentHelper	cancelItem(String materialDocumentYear, String materialDocument, String materialDocumentItem, LocalDateTime postingDate) Creates a fluent helper for the CancelItem OData function import.
MaterialDocumentHeaderCreateFluentHelper	createMaterialDocumentHeader(MaterialDocumentHeader materialDocumentHeader) Create a new MaterialDocumentHeader entity and save it to the S/4HANA system.
MaterialDocumentHeaderFluentHelper	getAllMaterialDocumentHeader() Fetch multiple MaterialDocumentHeader entities.
MaterialDocumentItemFluentHelper	getAllMaterialDocumentItem() Fetch multiple MaterialDocumentItem entities.
MaterialDocumentHeaderByKeyFluentHelper	getMaterialDocumentHeaderByKey(String materialDocumentYear, String materialDocument) Fetch a single MaterialDocumentHeader entity using key fields.
MaterialDocumentItemByKeyFluentHelper	getMaterialDocumentItemByKey(String materialDocumentYear, String materialDocument, String materialDocumentItem) Fetch a single MaterialDocumentItem entity using key fields.
DefaultMaterialDocumentService	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

DefaultMaterialDocumentService

public DefaultMaterialDocumentService()

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

Method Detail

withServicePath

@Nonnull
public DefaultMaterialDocumentService withServicePath(@Nonnull
                                                               String servicePath)

Description copied from interface: MaterialDocumentService

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 MaterialDocumentService

Parameters:

servicePath - Service path that will override the default.

Returns:

A new service instance with the specified service path

getAllMaterialDocumentHeader

@Nonnull
public MaterialDocumentHeaderFluentHelper getAllMaterialDocumentHeader()

Description copied from interface: MaterialDocumentService

Fetch multiple MaterialDocumentHeader entities.

Specified by:

getAllMaterialDocumentHeader in interface MaterialDocumentService

Returns:

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

getMaterialDocumentHeaderByKey

@Nonnull
public MaterialDocumentHeaderByKeyFluentHelper getMaterialDocumentHeaderByKey(String materialDocumentYear,
                                                                                       String materialDocument)

Description copied from interface: MaterialDocumentService

Fetch a single MaterialDocumentHeader entity using key fields.

Specified by:

getMaterialDocumentHeaderByKey in interface MaterialDocumentService

Parameters:

materialDocumentYear - Material Document Year

Constraints: Not nullable, Maximum length: 4

materialDocument - Alphanumeric key uniquely identifying the document.

Constraints: Not nullable, Maximum length: 10

Returns:

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

createMaterialDocumentHeader

@Nonnull
public MaterialDocumentHeaderCreateFluentHelper createMaterialDocumentHeader(@Nonnull
                                                                                      MaterialDocumentHeader materialDocumentHeader)

Description copied from interface: MaterialDocumentService

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

Specified by:

createMaterialDocumentHeader in interface MaterialDocumentService

Parameters:

materialDocumentHeader - MaterialDocumentHeader entity object that will be created in the S/4HANA system.

Returns:

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

getAllMaterialDocumentItem

@Nonnull
public MaterialDocumentItemFluentHelper getAllMaterialDocumentItem()

Description copied from interface: MaterialDocumentService

Fetch multiple MaterialDocumentItem entities.

Specified by:

getAllMaterialDocumentItem in interface MaterialDocumentService

Returns:

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

getMaterialDocumentItemByKey

@Nonnull
public MaterialDocumentItemByKeyFluentHelper getMaterialDocumentItemByKey(String materialDocumentYear,
                                                                                   String materialDocument,
                                                                                   String materialDocumentItem)

Description copied from interface: MaterialDocumentService

Fetch a single MaterialDocumentItem entity using key fields.

Specified by:

getMaterialDocumentItemByKey in interface MaterialDocumentService

Parameters:

materialDocumentYear - Material Document Year

Constraints: Not nullable, Maximum length: 4

materialDocument - Alphanumeric key uniquely identifying the document.

Constraints: Not nullable, Maximum length: 10

materialDocumentItem - Material Document Item

Constraints: Not nullable, Maximum length: 4

Returns:

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

cancel

@Nonnull
public CancelFluentHelper cancel(String materialDocumentYear,
                                          String materialDocument,
                                          LocalDateTime postingDate)

Description copied from interface: MaterialDocumentService

Creates a fluent helper for the Cancel OData function import.

Specified by:

cancel in interface MaterialDocumentService

Parameters:

materialDocumentYear - Material Doc. Year

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: MaterialDocumentYear

materialDocument - Material Document

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: MaterialDocument

postingDate - Posting Date

Constraints: Nullable, Precision: 0

Original parameter name from the Odata EDM: PostingDate

Returns:

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

cancelItem

@Nonnull
public CancelItemFluentHelper cancelItem(String materialDocumentYear,
                                                  String materialDocument,
                                                  String materialDocumentItem,
                                                  LocalDateTime postingDate)

Description copied from interface: MaterialDocumentService

Creates a fluent helper for the CancelItem OData function import.

Specified by:

cancelItem in interface MaterialDocumentService

Parameters:

materialDocumentYear - Material Doc. Year

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: MaterialDocumentYear

materialDocument - Material Document

Constraints: Not nullable, Maximum length: 10

Original parameter name from the Odata EDM: MaterialDocument

materialDocumentItem - Material Doc.Item

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: MaterialDocumentItem

postingDate - Posting Date

Constraints: Nullable, Precision: 0

Original parameter name from the Odata EDM: PostingDate

Returns:

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