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

csrfTokenRetriever, resourcePath, servicePath

Constructor Summary

Constructors

Constructor and Description
ODataRequestFunction(String servicePath, ODataResourcePath functionPath, ODataFunctionParameters parameters, String query, ODataProtocol protocol) Convenience constructor for invocations of unbound functions.
ODataRequestFunction(String servicePath, ODataResourcePath functionPath, String encodedQuery, ODataProtocol protocol) Default constructor for OData Function request.
ODataRequestFunction(String servicePath, ODataResourcePath functionPath, StructuredQuery structQuery) Constructor with StructuredQuery for OData Function request.
ODataRequestFunction(String servicePath, String functionName, ODataFunctionParameters parameters, ODataProtocol protocol) Convenience constructor for invocations of unbound functions.

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	getQuery()
URI	getRelativeUri() Get the static request URI of the OData resource.
String	getRequestQuery() Use all OData query information to construct a HTTP request query String.
int	hashCode()

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

addHeader, addHeaderIfAbsent, addListener, addQueryParameter, getHeaders, getListeners, getProtocol, getQueryParameters, getResourcePath, getServicePath, setCsrfTokenRetriever, 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,
                            @Nonnull
                            ODataFunctionParameters parameters,
                            @Nonnull
                            ODataProtocol protocol)

Convenience constructor for invocations of unbound functions. The function parameters will be added to the URL path or URL query depending on the OData protocol verison. For composable or bound functions please use ODataRequestFunction(String, ODataResourcePath, String, ODataProtocol) instead.

Parameters:

servicePath - The OData service path.

functionName - The name of the unbound OData function.

parameters - The parameters of the function invocation.

protocol - The OData protocol to use.

ODataRequestFunction

public ODataRequestFunction(@Nonnull
                            String servicePath,
                            @Nonnull
                            ODataResourcePath functionPath,
                            @Nonnull
                            ODataFunctionParameters parameters,
                            @Nullable
                            String query,
                            @Nonnull
                            ODataProtocol protocol)

Convenience constructor for invocations of unbound functions. The function parameters will be added to the URL path or URL query depending on the OData protocol verison. For composable or bound functions please use ODataRequestFunction(String, ODataResourcePath, String, ODataProtocol) instead.

Parameters:

servicePath - The OData service path.

functionPath - The full ODataResourcePath containing the function name, its parameters and possible further path segments. If this is a bound function the path must also contain the full path to the function.

parameters - The parameters of the function invocation.

query - Optional: The encoded HTTP query, if any.

protocol - The OData protocol to use.

ODataRequestFunction

public ODataRequestFunction(@Nonnull
                            String servicePath,
                            @Nonnull
                            ODataResourcePath functionPath,
                            @Nullable
                            String encodedQuery,
                            @Nonnull
                            ODataProtocol protocol)

Default constructor for OData Function request.

Parameters:

servicePath - The OData service path.

functionPath - The full ODataResourcePath containing the function name, its parameters and possible further path segments. If this is a bound function the path must also contain the full path to the function.

encodedQuery - Optional: The encoded HTTP query, if any.

protocol - The OData protocol to use.

ODataRequestFunction

public ODataRequestFunction(@Nonnull
                            String servicePath,
                            @Nonnull
                            ODataResourcePath functionPath,
                            @Nonnull
                            StructuredQuery structQuery)

Constructor with StructuredQuery for OData Function request.

Parameters:

servicePath - The OData service path.

functionPath - The full ODataResourcePath containing the function name, its parameters and possible further path segments. If this is a bound function the path must also contain the full path to the function.

structQuery - The structured query.

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.

getRequestQuery

@Nonnull
public String getRequestQuery()

Description copied from class: ODataRequestGeneric

Use all OData query information to construct a HTTP request query String.

Overrides:

getRequestQuery in class ODataRequestGeneric

Returns:

The request query.

getQuery

@Nonnull
public String getQuery()

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