com.xeiam.xchange.therock.service.polling

Class TheRockTradeService

java.lang.Object

com.xeiam.xchange.service.BaseExchangeService

com.xeiam.xchange.therock.service.polling.TheRockBasePollingService

com.xeiam.xchange.therock.service.polling.TheRockTradeServiceRaw

com.xeiam.xchange.therock.service.polling.TheRockTradeService

All Implemented Interfaces:

BasePollingService, PollingTradeService

public class TheRockTradeService
extends TheRockTradeServiceRaw
implements PollingTradeService

Author:

Matija Mazi

Field Summary

Fields inherited from class com.xeiam.xchange.service.BaseExchangeService

exchange

Constructor Summary

Constructors

Constructor and Description
TheRockTradeService(Exchange exchange)

Method Summary

Modifier and Type	Method and Description
boolean	cancelOrder(String orderId) cancels order with matching orderId
TradeHistoryParams	createTradeHistoryParams() Create TradeHistoryParams object specific to this exchange.
OpenOrders	getOpenOrders() Gets the open orders
UserTrades	getTradeHistory(Object... args) gets trade history for user's account
UserTrades	getTradeHistory(TradeHistoryParams params) Fetch the history of user trades.
String	placeLimitOrder(LimitOrder order) Place a limit order
String	placeMarketOrder(MarketOrder order) Place a market order

Methods inherited from class com.xeiam.xchange.therock.service.polling.TheRockTradeServiceRaw

placeOrder

Methods inherited from class com.xeiam.xchange.service.BaseExchangeService

getExchangeSymbols, verifyOrder, verifyOrder, verifyOrder

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.xeiam.xchange.service.polling.trade.PollingTradeService

verifyOrder, verifyOrder

Methods inherited from interface com.xeiam.xchange.service.polling.BasePollingService

getExchangeSymbols

Constructor Detail

TheRockTradeService

public TheRockTradeService(Exchange exchange)

Method Detail

placeMarketOrder

public String placeMarketOrder(MarketOrder order)
                        throws IOException,
                               TheRockException

Description copied from interface: PollingTradeService

Place a market order

Specified by:

placeMarketOrder in interface PollingTradeService

Returns:

the order ID

Throws:

IOException - - Indication that a networking error occurred while fetching JSON data

TheRockException

placeLimitOrder

public String placeLimitOrder(LimitOrder order)
                       throws IOException,
                              TheRockException

Description copied from interface: PollingTradeService

Place a limit order

Specified by:

placeLimitOrder in interface PollingTradeService

Returns:

the order ID

Throws:

IOException - - Indication that a networking error occurred while fetching JSON data

TheRockException

getOpenOrders

public OpenOrders getOpenOrders()
                         throws IOException,
                                TheRockException

Description copied from interface: PollingTradeService

Gets the open orders

Specified by:

getOpenOrders in interface PollingTradeService

Returns:

the open orders, null if some sort of error occurred. Implementers should log the error.

Throws:

IOException - - Indication that a networking error occurred while fetching JSON data

TheRockException

cancelOrder

public boolean cancelOrder(String orderId)
                    throws IOException,
                           TheRockException

Description copied from interface: PollingTradeService

cancels order with matching orderId

Specified by:

cancelOrder in interface PollingTradeService

Returns:

true if order was successfully cancelled, false otherwise.

Throws:

IOException - - Indication that a networking error occurred while fetching JSON data

TheRockException

getTradeHistory

public UserTrades getTradeHistory(Object... args)
                           throws IOException,
                                  TheRockException

Description copied from interface: PollingTradeService

gets trade history for user's account

Specified by:

getTradeHistory in interface PollingTradeService

Returns:

Throws:

IOException - - Indication that a networking error occurred while fetching JSON data

TheRockException

getTradeHistory

public UserTrades getTradeHistory(TradeHistoryParams params)
                           throws IOException

Description copied from interface: PollingTradeService

Fetch the history of user trades.

If you are calling this method for single exchange, known at the development time, you may pass an object of specific *TradeHistoryParam class that is nested it that exchange's trade service.

If, however, you are fetching user trade history from many exchanges using the same code, you will find useful to create the parameter object with PollingTradeService.createTradeHistoryParams() and check which parameters are required or supported using instanceof operator. See subinterfaces of TradeHistoryParams. Note that whether an interface is required or supported will vary from exchange to exchange and it's described only through the javadoc.

There is also implementation of all the common interfaces, TradeHistoryParamsAll , that, with all properties set non-null, should work with any exchange.

Some exchanges allow extra parameters, not covered by any common interface. To access them, you will have to use the object returned by PollingTradeService.createTradeHistoryParams() and cast it to the exchange-specific type.

Specified by:

getTradeHistory in interface PollingTradeService

Parameters:

params - The parameters describing the filter. Note that TradeHistoryParams is an empty interface. Exact set of interfaces that are required or supported by this method is described by the type of object returned from PollingTradeService.createTradeHistoryParams() and the javadoc of the method.

Returns:

UserTrades as returned by the exchange API

Throws:

IOException - - Indication that a networking error occurred while fetching JSON data

See Also:

PollingTradeService.getTradeHistory(Object...), PollingTradeService.createTradeHistoryParams(), TradeHistoryParamsAll

createTradeHistoryParams

public TradeHistoryParams createTradeHistoryParams()

Description copied from interface: PollingTradeService

Create TradeHistoryParams object specific to this exchange. Object created by this method may be used to discover supported and required PollingTradeService.getTradeHistory(TradeHistoryParams) parameters and should be passed only to the method in the same class as the createTradeHistoryParams that created the object.

Specified by:

createTradeHistoryParams in interface PollingTradeService