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

Class StrategyFieldSet

java.lang.Object

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

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

public class StrategyFieldSet
extends BaseFieldSet

Represents a set of fields relating to an order strategy.

You do not have to create instances of this class yourself. You can retrieve instances of this class by calling StrategyBuilder.getEditableFields() or StrategyBuilder.getFixedFields().

Method Summary

Modifier and Type	Method and Description
StrategyFieldSet	setAccount(Account account) Sets the account.
StrategyFieldSet	setAccount(String accountID, String accountName) Sets the account.
StrategyFieldSet	setActivationDate(ActivationDate activationDate) Sets the date, time and location the strategy or order should be activated.
StrategyFieldSet	setAlertType(Set<AlertType> alertTypes) Sets the AlertType
StrategyFieldSet	setCurrencyPair(String value) Sets the currency pair.
StrategyFieldSet	setExpirationDate(ExpirationDate expirationDate) Sets the date, time and location the strategy or order should expire.
StrategyFieldSet	setMemo(String memo) Set Memo - the taker short note of the order.
StrategyFieldSet	setRemarks(String remarks) Sets the Remarks
StrategyFieldSet	setSpotRateDPS(Object spotRateDPS) Sets the spot rate DPS.
StrategyFieldSet	setStrategyType(StrategyType strategyType) Sets the type of the strategy, for example SINGLE or OCO ("One Cancels the Other").
StrategyFieldSet	setSubmittedBy(String username) Sets the username of the user who submitted the strategy.
StrategyFieldSet	setSubmittedFor(String username) Sets the username of the user who the strategy is for.
StrategyFieldSet	setTOBOUser(String toboUser) Sets the trade on behalf of user.

Methods inherited from class com.caplin.motif.fx.trading.orders.details.BaseFieldSet

setField, setFields, toString

Methods inherited from class java.lang.Object

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

Method Detail

setAccount

public StrategyFieldSet setAccount(String accountID,
                                   String accountName)

Sets the account.

Parameters:

accountID - The identifier of the account.

accountName - A "friendly name" for the account, for display in the front end.

Returns:

This instance, to allow method chaining.

setAccount

public StrategyFieldSet setAccount(Account account)

Sets the account.

Parameters:

account - The account, with id and name

Returns:

This instance, to allow method chaining.

setCurrencyPair

public StrategyFieldSet setCurrencyPair(String value)

Sets the currency pair. This must be a six character string where the first three characters are the base currency and the second three characters are the term currency, for example USDJPY.

Parameters:

value - The currency pair.

Returns:

This instance, to allow method chaining.

setActivationDate

public StrategyFieldSet setActivationDate(ActivationDate activationDate)

Sets the date, time and location the strategy or order should be activated. Certain other values for the activation date are acceptable, for example GFA meaning "Good for Activation" immediately.

Parameters:

activationDate - A domain object representing the activation date.

Returns:

This instance, to allow method chaining.

See Also:

ActivationDate

setExpirationDate

public StrategyFieldSet setExpirationDate(ExpirationDate expirationDate)

Sets the date, time and location the strategy or order should expire. Certain other values for the expiration date are acceptable, for example GTC for "Good til Canceled" or GFD for "Good for Day".

Parameters:

expirationDate - A domain object representing the expiration date.

Returns:

This instance, to allow method chaining.

setAlertType

public StrategyFieldSet setAlertType(Set<AlertType> alertTypes)

Sets the AlertType

Parameters:

alertTypes - the set of AlertTypes for this strategy

Returns:

This instance, to allow method chaining.

setRemarks

public StrategyFieldSet setRemarks(String remarks)

Sets the Remarks

Parameters:

remarks - to be attached to the order or strategy

Returns:

This instance, to allow method chaining.

setMemo

public StrategyFieldSet setMemo(String memo)

Set Memo - the taker short note of the order.

Parameters:

memo - to be attached to the order or strategy

Returns:

This instance, to allow method chaining.

setStrategyType

public StrategyFieldSet setStrategyType(StrategyType strategyType)

Sets the type of the strategy, for example SINGLE or OCO ("One Cancels the Other").

Parameters:

strategyType - The type of the strategy.

Returns:

This instance, to allow method chaining.

setSubmittedBy

public StrategyFieldSet setSubmittedBy(String username)

Sets the username of the user who submitted the strategy.

Parameters:

username - The username.

Returns:

This instance, to allow method chaining.

setSubmittedFor

public StrategyFieldSet setSubmittedFor(String username)

Sets the username of the user who the strategy is for. This could be different to the user the strategy was submitted by if there is a sales trader involved.

Parameters:

username - The username.

Returns:

This instance, to allow method chaining.

setTOBOUser

public StrategyFieldSet setTOBOUser(String toboUser)

Sets the trade on behalf of user. Use this for sales motifs.

Parameters:

toboUser -

Returns:

This instance, to allow method chaining.

setSpotRateDPS

public StrategyFieldSet setSpotRateDPS(Object spotRateDPS)

Sets the spot rate DPS.

Parameters:

spotRateDPS -

Returns:

This instance, to allow method chaining.