oracle.kv.query

Class ExecuteOptions

java.lang.Object

oracle.kv.query.ExecuteOptions

public class ExecuteOptions
extends Object

Class contains several options for the KVStore.execute() methods. It contains the following execution options: consistency, durability and timeout.

Since:

4.0

See Also:

KVStore.execute(String, ExecuteOptions), KVStore.executeSync(String, ExecuteOptions), KVStore.executeSync(Statement, ExecuteOptions)

Constructor Summary

Constructors

Constructor and Description
ExecuteOptions()

Method Summary

Modifier and Type	Method and Description
Consistency	getConsistency() Gets the last set execution consistency.
Durability	getDurability() Gets the last set execution durability.
MathContext	getMathContext() Returns the MathContext used for BigDecimal and BigInteger operations.
int	getMaxConcurrentRequests() Returns the maximum number of concurrent requests.
int	getResultsBatchSize() Returns the number of results per request.
long	getTimeout() Gets the timeout, which is an upper bound on the time interval for processing the read or write operations.
TimeUnit	getTimeoutUnit() Gets the unit of the timeout parameter, and may be null only if getTimeout() returns zero.
ExecuteOptions	setConsistency(Consistency consistency) Sets the execution consistency.
ExecuteOptions	setDurability(Durability durability) Sets the execution durability.
ExecuteOptions	setMathContext(MathContext mathContext) Sets the MathContext used for BigDecimal and BigInteger operations.
ExecuteOptions	setMaxConcurrentRequests(int maxConcurrentRequests) Sets the maximum number of concurrent requests.
ExecuteOptions	setResultsBatchSize(int resultsBatchSize) Sets the number of results per request.
ExecuteOptions	setTimeout(long timeout, TimeUnit timeoutUnit) The timeout parameter is an upper bound on the time interval for processing the operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExecuteOptions

public ExecuteOptions()

Method Detail

setConsistency

public ExecuteOptions setConsistency(Consistency consistency)

Sets the execution consistency.

getConsistency

public Consistency getConsistency()

Gets the last set execution consistency.

setDurability

public ExecuteOptions setDurability(Durability durability)

Sets the execution durability.

getDurability

public Durability getDurability()

Gets the last set execution durability.

setTimeout

public ExecuteOptions setTimeout(long timeout,
                                 TimeUnit timeoutUnit)

The timeout parameter is an upper bound on the time interval for processing the operation. A best effort is made not to exceed the specified limit. If zero, the default request timeout is used.

If timeout is not 0, the timeoutUnit parameter must not be null.

Parameters:

timeout - the timeout value to use

timeoutUnit - the TimeUnit used by the timeout parameter or null

getTimeout

public long getTimeout()

Gets the timeout, which is an upper bound on the time interval for processing the read or write operations. A best effort is made not to exceed the specified limit. If zero, the default request timeout is used.

Returns:

the timeout

getTimeoutUnit

public TimeUnit getTimeoutUnit()

Gets the unit of the timeout parameter, and may be null only if getTimeout() returns zero.

Returns:

the timeout unit or null

getMaxConcurrentRequests

public int getMaxConcurrentRequests()

Returns the maximum number of concurrent requests.

setMaxConcurrentRequests

public ExecuteOptions setMaxConcurrentRequests(int maxConcurrentRequests)

Sets the maximum number of concurrent requests.

getResultsBatchSize

public int getResultsBatchSize()

Returns the number of results per request.

setResultsBatchSize

public ExecuteOptions setResultsBatchSize(int resultsBatchSize)

Sets the number of results per request.

getMathContext

public MathContext getMathContext()

Returns the MathContext used for BigDecimal and BigInteger operations. MathContext.DECIMAL32 is used by default.

setMathContext

public ExecuteOptions setMathContext(MathContext mathContext)

Sets the MathContext used for BigDecimal and BigInteger operations. MathContext.DECIMAL32 is used by default.