com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.materialdocument

Class CancelItemFluentHelper

java.lang.Object

com.sap.cloud.sdk.s4hana.datamodel.odata.helper.FluentHelperBasic<FluentHelperT,ObjectT,ResultT>

com.sap.cloud.sdk.s4hana.datamodel.odata.helper.FluentHelperFunction<CancelItemFluentHelper,MaterialDocumentItem,MaterialDocumentItem>

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.materialdocument.CancelItemFluentHelper

public class CancelItemFluentHelper
extends FluentHelperFunction<CancelItemFluentHelper,MaterialDocumentItem,MaterialDocumentItem>

Fluent helper for the CancelItem OData function import.

Constructor Summary

Constructors

Constructor and Description
CancelItemFluentHelper(String materialDocumentYear, String materialDocument, String materialDocumentItem, LocalDateTime postingDate) Creates a fluent helper object that will execute the CancelItem OData function import with the provided parameters.

Method Summary

Modifier and Type	Method and Description
protected org.apache.http.client.methods.HttpUriRequest	createRequest(URI uri)
MaterialDocumentItem	execute(ErpConfigContext configContext) Executes the underlying query using the stored values, plus any query modifiers that were previously called.
protected Class<MaterialDocumentItem>	getEntityClass()
protected String	getFunctionName()
protected Map<String,Object>	getParameters()
protected String	getPath()

Methods inherited from class com.sap.cloud.sdk.s4hana.datamodel.odata.helper.FluentHelperFunction

executeMultiple, executeSingle

Methods inherited from class com.sap.cloud.sdk.s4hana.datamodel.odata.helper.FluentHelperBasic

execute, getHeadersForRequestAndImplicitRequests, getHeadersForRequestOnly, getThis, getVersionIdentifier, withCustomHttpHeader, withCustomHttpHeaders, withHttpHeader

Methods inherited from class java.lang.Object

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

Constructor Detail

CancelItemFluentHelper

public CancelItemFluentHelper(String materialDocumentYear,
                              String materialDocument,
                              String materialDocumentItem,
                              LocalDateTime postingDate)

Creates 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.

Parameters:

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

materialDocumentYear - Material Doc. Year

Constraints: Not nullable, Maximum length: 4

Original parameter name from the Odata EDM: MaterialDocumentYear

postingDate - Posting Date

Constraints: Nullable, Precision: 0

Original parameter name from the Odata EDM: PostingDate

Method Detail

getEntityClass

protected Class<MaterialDocumentItem> getEntityClass()

Specified by:

getEntityClass in class FluentHelperBasic<CancelItemFluentHelper,MaterialDocumentItem,MaterialDocumentItem>

getPath

protected String getPath()

Specified by:

getPath in class FluentHelperFunction<CancelItemFluentHelper,MaterialDocumentItem,MaterialDocumentItem>

getFunctionName

protected String getFunctionName()

Specified by:

getFunctionName in class FluentHelperFunction<CancelItemFluentHelper,MaterialDocumentItem,MaterialDocumentItem>

getParameters

protected Map<String,Object> getParameters()

Specified by:

getParameters in class FluentHelperFunction<CancelItemFluentHelper,MaterialDocumentItem,MaterialDocumentItem>

createRequest

protected org.apache.http.client.methods.HttpUriRequest createRequest(URI uri)

Specified by:

createRequest in class FluentHelperFunction<CancelItemFluentHelper,MaterialDocumentItem,MaterialDocumentItem>

execute

public MaterialDocumentItem execute(ErpConfigContext configContext)
                             throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Executes the underlying query using the stored values, plus any query modifiers that were previously called.

Specified by:

execute in class FluentHelperBasic<CancelItemFluentHelper,MaterialDocumentItem,MaterialDocumentItem>

Parameters:

configContext - Supply the ERP system context for executing the underlying OData query.

Returns:

A single entity if the query execution is successful. If the underlying OData request fails, then an ODataException is thrown, and the error handler class attached to this fluent helper will be called.

Throws:

com.sap.cloud.sdk.odatav2.connectivity.ODataException

See Also:

ErpConfigContext.ErpConfigContext()