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

Class JobCancelFluentHelper

java.lang.Object

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

com.sap.cloud.sdk.s4hana.datamodel.odata.helper.FluentHelperFunction<JobCancelFluentHelper,FuncImpReturn,FuncImpReturn>

com.sap.cloud.sdk.s4hana.datamodel.odata.namespaces.externaljobschedulerintegration.JobCancelFluentHelper

public class JobCancelFluentHelper
extends FluentHelperFunction<JobCancelFluentHelper,FuncImpReturn,FuncImpReturn>

Fluent helper for the JobCancel OData function import.

Constructor Summary

Constructors

Constructor and Description
JobCancelFluentHelper(String servicePath, String jobRunCount, String jobName) Creates a fluent helper object that will execute the JobCancel 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) Creates a request for this function based on the given URI.
FuncImpReturn	execute(ErpConfigContext configContext) Executes the underlying query using the stored values, plus any query modifiers that were previously called.
protected Class<FuncImpReturn>	getEntityClass() Returns a class object of the type this fluent helper works with.
protected String	getFunctionName() The exact name of the function to be called on the OData Endpoint.
protected Map<String,Object>	getParameters() Getter for the map of parameters to be used in the function call.

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

asResilientCommand, asResilientCommand, cachingMetadata, execute, getHeadersForRequestAndImplicitRequests, getHeadersForRequestOnly, getParametersForRequestOnly, getServicePath, getThis, getVersionIdentifier, isCachingMetadata, withCustomHttpHeader, withCustomHttpHeaders, withCustomQueryParameter, withoutCachingMetadata

Methods inherited from class java.lang.Object

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

Constructor Detail

JobCancelFluentHelper

public JobCancelFluentHelper(@Nonnull
                             String servicePath,
                             String jobRunCount,
                             String jobName)

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

Parameters:

jobName - Constraints: Not nullable, Maximum length: 32

Original parameter name from the Odata EDM: JobName

servicePath - Service path to be used to call the functions against.

jobRunCount - Constraints: Not nullable, Maximum length: 14

Original parameter name from the Odata EDM: JobRunCount

Method Detail

getEntityClass

@Nonnull
protected Class<FuncImpReturn> getEntityClass()

Description copied from class: FluentHelperBasic

Returns a class object of the type this fluent helper works with.

Specified by:

getEntityClass in class FluentHelperBasic<JobCancelFluentHelper,FuncImpReturn,FuncImpReturn>

Returns:

A class object of the handled type.

getFunctionName

@Nonnull
protected String getFunctionName()

Description copied from class: FluentHelperFunction

The exact name of the function to be called on the OData Endpoint.

Specified by:

getFunctionName in class FluentHelperFunction<JobCancelFluentHelper,FuncImpReturn,FuncImpReturn>

Returns:

The function name on the endpoint.

getParameters

@Nonnull
protected Map<String,Object> getParameters()

Description copied from class: FluentHelperFunction

Getter for the map of parameters to be used in the function call.

The map maps the ODataName of a parameter to the corresponding value.

Specified by:

getParameters in class FluentHelperFunction<JobCancelFluentHelper,FuncImpReturn,FuncImpReturn>

Returns:

A map containing the parameter for the function call.

createRequest

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

Description copied from class: FluentHelperFunction

Creates a request for this function based on the given URI.

Examples for such requests are HttpGet and HttpPost.

Specified by:

createRequest in class FluentHelperFunction<JobCancelFluentHelper,FuncImpReturn,FuncImpReturn>

Parameters:

uri - The URI the request should target.

Returns:

The instantiated request.

execute

@Nullable
public FuncImpReturn execute(@Nonnull
                                       ErpConfigContext configContext)
                                throws com.sap.cloud.sdk.odatav2.connectivity.ODataException

Description copied from class: FluentHelperBasic

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

Specified by:

execute in class FluentHelperBasic<JobCancelFluentHelper,FuncImpReturn,FuncImpReturn>

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()