com.sap.cloud.server.odata

Class RequestOptions

java.lang.Object

com.sap.cloud.server.odata.RequestOptions

public class RequestOptions
extends java.lang.Object

Options for processing of data requests. If request options are used for RequestOptions.repeatable requests, a new request options object should be used for each distinct request (or the RequestOptions.repeatable property should be reset before object re-use). The repeated execution of a failed request should re-use the original request options object without RequestOptions.repeatable being reset beforehand.

Field Summary

Fields

Modifier and Type	Field and Description
static RequestOptions	none

Constructor Summary

Constructors

Constructor and Description
RequestOptions()

Method Summary

Modifier and Type	Method and Description
RequestOptions	cancelable(CancelToken token) Set the RequestOptions.cancelToken and return this options object.
RequestOptions	copy() Return a new (mutable) request options object that is a copy of this request options object.
CancelToken	getCancelToken() Return (nullable) Set this to a cancellation token before initiating an async request if request cancellation may be needed.
boolean	getPreferNoContent() Return should create/update requests receive no content in the response? Defaults to false.
GlobalDateTime	getRepeatabilityFirstSent() Return (nullable) Repeatability first sent time for this request.
GuidValue	getRepeatabilityRequestID() Return (nullable) Repeatability global request ID for this request.
boolean	getSendEmptyUpdate() Return should no-change update requests be sent to the server? Defaults to false.
UpdateMode	getUpdateMode() Return determines if updates use merge (HTTP PATCH) or replace (HTTP PUT) semantics.
static RequestOptions	noneIfNull(RequestOptions options) Construct a new RequestOptions and apply default none value to that if the options parameter is null.
RequestOptions	repeatable(GuidValue requestID, GlobalDateTime firstSent) Set the RequestOptions.repeatabilityRequestID and RequestOptions.repeatabilityFirstSent and return this options object.
void	setCancelToken(CancelToken value) Set set this to a cancellation token before initiating an async request if request cancellation may be needed.
void	setPreferNoContent(boolean value) Set should create/update requests receive no content in the response? Defaults to false.
void	setRepeatabilityFirstSent(GlobalDateTime value) Set repeatability first sent time for this request.
void	setRepeatabilityRequestID(GuidValue value) Set repeatability global request ID for this request.
void	setSendEmptyUpdate(boolean value) Set should no-change update requests be sent to the server? Defaults to false.
void	setUpdateMode(UpdateMode value) Set determines if updates use merge (HTTP PATCH) or replace (HTTP PUT) semantics.

Methods inherited from class java.lang.Object

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

Field Detail

none

public static final RequestOptions none

Constructor Detail

RequestOptions

public RequestOptions()

Method Detail

cancelable

public RequestOptions cancelable(CancelToken token)

Set the RequestOptions.cancelToken and return this options object.

Parameters:

token - Cancellation token.

Returns:

This options object.

copy

public RequestOptions copy()

Return a new (mutable) request options object that is a copy of this request options object.

Returns:

a new (mutable) request options object that is a copy of this request options object.

getCancelToken

public CancelToken getCancelToken()

Return (nullable) Set this to a cancellation token before initiating an async request if request cancellation may be needed.

Returns:

(nullable) Set this to a cancellation token before initiating an async request if request cancellation may be needed.

getPreferNoContent

public boolean getPreferNoContent()

Return should create/update requests receive no content in the response? Defaults to false.

Returns:

Should create/update requests receive no content in the response? Defaults to false.

getRepeatabilityFirstSent

public GlobalDateTime getRepeatabilityFirstSent()

Return (nullable) Repeatability first sent time for this request.

See Also:

RequestOptions.repeatable.

Returns:

(nullable) Repeatability first sent time for this request.

getRepeatabilityRequestID

public GuidValue getRepeatabilityRequestID()

Return (nullable) Repeatability global request ID for this request.

See Also:

RequestOptions.repeatable.

Returns:

(nullable) Repeatability global request ID for this request.

getSendEmptyUpdate

public boolean getSendEmptyUpdate()

Return should no-change update requests be sent to the server? Defaults to false.

Returns:

Should no-change update requests be sent to the server? Defaults to false.

getUpdateMode

public UpdateMode getUpdateMode()

Return determines if updates use merge (HTTP PATCH) or replace (HTTP PUT) semantics. Defaults to merge semantics.

Returns:

Determines if updates use merge (HTTP PATCH) or replace (HTTP PUT) semantics. Defaults to merge semantics.

noneIfNull

public static RequestOptions noneIfNull(RequestOptions options)

Construct a new RequestOptions and apply default none value to that if the options parameter is null.

Parameters:

options - (nullable) RequestOptions to be checked.

Returns:

The options parameter, if non-null. Otherwise a RequestOptions with default none value.

repeatable

public RequestOptions repeatable(GuidValue requestID,
                                 GlobalDateTime firstSent)

Set the RequestOptions.repeatabilityRequestID and RequestOptions.repeatabilityFirstSent and return this options object.

Parameters:

requestID - Value for RequestOptions.repeatabilityRequestID.

firstSent - Value for RequestOptions.repeatabilityFirstSent.

Returns:

This options object.

setCancelToken

public void setCancelToken(CancelToken value)

Set set this to a cancellation token before initiating an async request if request cancellation may be needed.

Parameters:

value - Set this to a cancellation token before initiating an async request if request cancellation may be needed.

setPreferNoContent

public void setPreferNoContent(boolean value)

Set should create/update requests receive no content in the response? Defaults to false.

Parameters:

value - Should create/update requests receive no content in the response? Defaults to false.

setRepeatabilityFirstSent

public void setRepeatabilityFirstSent(GlobalDateTime value)

Set repeatability first sent time for this request.

See Also:

RequestOptions.repeatable.

Parameters:

value - Repeatability first sent time for this request.

setRepeatabilityRequestID

public void setRepeatabilityRequestID(GuidValue value)

Set repeatability global request ID for this request.

See Also:

RequestOptions.repeatable.

Parameters:

value - Repeatability global request ID for this request.

setSendEmptyUpdate

public void setSendEmptyUpdate(boolean value)

Set should no-change update requests be sent to the server? Defaults to false.

Parameters:

value - Should no-change update requests be sent to the server? Defaults to false.

setUpdateMode

public void setUpdateMode(UpdateMode value)

Set determines if updates use merge (HTTP PATCH) or replace (HTTP PUT) semantics. Defaults to merge semantics.

Parameters:

value - Determines if updates use merge (HTTP PATCH) or replace (HTTP PUT) semantics. Defaults to merge semantics.