com.sap.cloud.sdk.datamodel.odata.client.request

Class ODataRequestFunction

java.lang.Object

com.sap.cloud.sdk.datamodel.odata.client.request.ODataRequestGeneric

com.sap.cloud.sdk.datamodel.odata.client.request.ODataRequestFunction

All Implemented Interfaces:

ODataRequestExecutable

@Beta
public class ODataRequestFunction
extends ODataRequestGeneric

The executable OData function request.

Field Summary

Fields inherited from class com.sap.cloud.sdk.datamodel.odata.client.request.ODataRequestGeneric

DEFAULT_FORMAT, servicePath

Constructor Summary

Constructors

Constructor and Description
ODataRequestFunction(String servicePath, String functionName, String parameters, ODataProtocol protocol) Default constructor for OData Function request.

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
ODataRequestResultGeneric	execute(org.apache.http.client.HttpClient httpClient) Execute the OData request with the provided HttpClient reference.
String	getFunctionName()
String	getParameters()
URI	getRelativeUri() Get the static request URI of the OData resource.
int	hashCode()

Methods inherited from class com.sap.cloud.sdk.datamodel.odata.client.request.ODataRequestGeneric

addHeader, addHeaderIfAbsent, addListener, addQueryParameter, getHeaders, getListeners, getProtocol, getQueryParameters, getRequestQuery, getServicePath, setCsrfTokenRetriever, setResponseFormat, tryExecute, tryExecuteWithCsrfToken

Methods inherited from class java.lang.Object

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

Constructor Detail

ODataRequestFunction

public ODataRequestFunction(@Nonnull
                            String servicePath,
                            @Nonnull
                            String functionName,
                            @Nullable
                            String parameters,
                            @Nonnull
                            ODataProtocol protocol)

Default constructor for OData Function request.

Parameters:

servicePath - The OData service path.

functionName - The OData function name.

parameters - The function parameters as HTTP query.

protocol - The OData protocol to use.

Method Detail

getRelativeUri

@Nonnull
public URI getRelativeUri()

Get the static request URI of the OData resource.

Specified by:

getRelativeUri in class ODataRequestGeneric

Returns:

The String representation of the request URI.

execute

@Nonnull
public ODataRequestResultGeneric execute(@Nonnull
                                                  org.apache.http.client.HttpClient httpClient)

Execute the OData request with the provided HttpClient reference.

Parameters:

httpClient - The HttpClient.

Returns:

An OData request result.

getFunctionName

@Nonnull
public String getFunctionName()

getParameters

@Nullable
public String getParameters()

equals

public boolean equals(@Nullable
                      Object o)

Overrides:

equals in class ODataRequestGeneric

canEqual

protected boolean canEqual(@Nullable
                           Object other)

Overrides:

canEqual in class ODataRequestGeneric

hashCode

public int hashCode()

Overrides:

hashCode in class ODataRequestGeneric