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

Class ODataRequestAction

java.lang.Object

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

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

All Implemented Interfaces:

ODataRequestExecutable

@Beta
public class ODataRequestAction
extends ODataRequestGeneric

The executable OData action 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
ODataRequestAction(String servicePath, ODataResourcePath actionPath, String actionParameters, ODataProtocol protocol) Default constructor for OData Action request.
ODataRequestAction(String servicePath, ODataResourcePath actionPath, String actionParameters, String encodedQuery, ODataProtocol protocol) Constructor with StructuredQuery for OData Function request.
ODataRequestAction(String servicePath, String actionName, String actionParameters, ODataProtocol protocol) Convenience constructor for invocations of unbound actions.

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

ODataRequestAction

public ODataRequestAction(@Nonnull
                          String servicePath,
                          @Nonnull
                          String actionName,
                          @Nullable
                          String actionParameters,
                          @Nonnull
                          ODataProtocol protocol)

Convenience constructor for invocations of unbound actions. For bound actions use ODataRequestAction(String, ODataResourcePath, String, ODataProtocol).

Parameters:

servicePath - The OData service path.

actionName - The action name.

actionParameters - Optional: The action parameters HTTP payload.

protocol - The OData protocol to use.

ODataRequestAction

public ODataRequestAction(@Nonnull
                          String servicePath,
                          @Nonnull
                          ODataResourcePath actionPath,
                          @Nullable
                          String actionParameters,
                          @Nonnull
                          ODataProtocol protocol)

Default constructor for OData Action request.

Parameters:

servicePath - The OData service path.

actionPath - The path identifying the action. In case of an unbound action this is simply the action name. If this is a bound action the path must also contain the full path to the action.

actionParameters - Optional: The action parameters as HTTP payload. This is expected to be a JSON formatted String.

protocol - The OData protocol to use.

ODataRequestAction

public ODataRequestAction(@Nonnull
                          String servicePath,
                          @Nonnull
                          ODataResourcePath actionPath,
                          @Nullable
                          String actionParameters,
                          @Nullable
                          String encodedQuery,
                          @Nonnull
                          ODataProtocol protocol)

Constructor with StructuredQuery for OData Function request.

Parameters:

servicePath - The OData service path.

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

actionParameters - Optional: The action parameters as HTTP payload. This is expected to be a JSON formatted String.

encodedQuery - Optional: An encodedQuery HTTP request query.

protocol - The OData protocol to use.

Method Detail

getRelativeUri

@Nonnull
public URI getRelativeUri()

Description copied from class: ODataRequestGeneric

Get the static request URI of the OData resource.

Specified by:

getRelativeUri in class ODataRequestGeneric

Returns:

The String representation of the request URI.

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.

execute

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

Description copied from interface: ODataRequestExecutable

Execute the OData request with the provided HttpClient reference.

Parameters:

httpClient - The HttpClient.

Returns:

An OData request result.

getActionParameters

@Nonnull
public String getActionParameters()

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