com.caplin.motif.fx.trading.orders.details

Interface StrategyDetailsCallback

All Known Implementing Classes:

StrategyDetailsCallbackImpl

public interface StrategyDetailsCallback

Callback used for sending the details of a strategy back to the client in response to an strategy details request.

Your implementation of StrategyDetailsRequestListener will be passed an instance of this interface on the StrategyDetailsRequestListener.onStrategyDetailsRequest(StrategySubjectInfo, StrategyDetailsCallback) callback method.

Method Summary

Modifier and Type	Method and Description
void	onError(String error) Call this method if you cannot or do not wish to provide details of the strategy to the client.
void	onImage(Strategy strategy) Call this method when you have retrieved the details of the strategy from your trading system and are ready to send them back to the client.
void	onUpdate(Strategy strategy) Call this method when you have retrieved the details of the strategy from your trading system and are ready to send them back to the client.

Method Detail

onImage

void onImage(Strategy strategy)

Call this method when you have retrieved the details of the strategy from your trading system and are ready to send them back to the client. Instances of Strategy can be built using the StrategyBuilder.

You can call this method multiple times if the state of the order strategy changes (for example it receives a fill or is canceled) and you want to update the client with the new state.

Sending an image will wipe all previously sent fields and send this strategy's fields alone. To send a combination of this strategy's fields overlaid on top of previous updates, use onUpdate(com.caplin.motif.fx.trading.orders.details.Strategy)

Parameters:

strategy - The Strategy to send to the client.

Throws:

IllegalStateException - If you previously called onError(String), putting this StrategyDetailsCallback in a terminal state.

See Also:

StrategyBuilder

onUpdate

void onUpdate(Strategy strategy)

Call this method when you have retrieved the details of the strategy from your trading system and are ready to send them back to the client. Instances of Strategy can be built using the StrategyBuilder.

You can call this method multiple times if the state of the order strategy changes (for example it receives a fill or is canceled) and you want to update the client with the new state.

Sending an update will send a combination of this strategy's fields overlaid on top of previous updates. To wipe all previously sent fields and send this strategy's fields alone use onImage(com.caplin.motif.fx.trading.orders.details.Strategy)

Parameters:

strategy - The Strategy to send to the client.

Throws:

IllegalStateException - If you previously called onError(String), putting this StrategyDetailsCallback in a terminal state.

See Also:

StrategyBuilder

onError

void onError(String error)

Call this method if you cannot or do not wish to provide details of the strategy to the client. This could happen if no strategy with the requested ID can be found, or if the requesting user is not permitted to view the details of the strategy.

Calling this method puts the StrategyDetailsCallback in a terminal state. An exception will be thrown if you call onUpdate(Strategy) after calling this method.

Parameters:

error - An error code which will be sent to the client. The client application can convert this error code into an internationalised message to present to the user.