Package velox.api.layer1.data

Class OrderCancelParameters

java.lang.Object

velox.api.layer1.data.OrderUpdateParameters

velox.api.layer1.data.OrderCancelParameters

public class OrderCancelParameters
extends OrderUpdateParameters

Used to cancel the order

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	OrderCancelParameters.Builder

Field Summary

Fields

Modifier and Type	Field	Description
final boolean	batchEnd	Marks end of batch.
final long	batchId	Orders with the same value will be attempted to be cancelled at once.

Fields inherited from class velox.api.layer1.data.OrderUpdateParameters

orderEntryType, orderId

Constructor Summary

Constructors

Constructor	Description
OrderCancelParameters(String orderId)	Request to cancel single order
OrderCancelParameters(String orderId, boolean batchEnd)	Request to cancel single order.
OrderCancelParameters(String orderId, long batchId, boolean batchEnd)

Method Summary

Modifier and Type	Method	Description
OrderCancelParameters.Builder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

batchId

public final long batchId

Orders with the same value will be attempted to be cancelled at once. This is a hint to provider that these requests are sent at once and optimizations can be applied. Some providers might skip redundant cancellations within batch.

batchEnd

public final boolean batchEnd

Marks end of batch. Failing to send this might indefinitely delay execution of batch.

Constructor Details

OrderCancelParameters

public OrderCancelParameters(String orderId)

Request to cancel single order

OrderCancelParameters

public OrderCancelParameters(String orderId,
 boolean batchEnd)

Request to cancel single order.

Parameters:

orderId - ID of the order to cancel.

batchEnd - If true it's a single order cancellation request. If false it's a start of new cancellation batch. Unique batch ID will be generated automatically.

OrderCancelParameters

public OrderCancelParameters(String orderId,
 long batchId,
 boolean batchEnd)

Method Details

toBuilder

public OrderCancelParameters.Builder toBuilder()

Overrides:

toBuilder in class OrderUpdateParameters

toString

public String toString()

Overrides:

toString in class OrderUpdateParameters