Annotation Interface StudyHeader

@Retention(RUNTIME)
@Target(TYPE)
public @interface StudyHeader

This annotation is used to describe information about the study when the study is loaded by MotiveWave.

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	desc	Description displayed in the study dialog.
String	id	Unique (within the namespace) ID for this study.
String	name	Displayed name of this study.
String	namespace	Namespace for this study (Must be unique for your organization)
boolean	overlay	Indicates if this study is an overlay that may be placed on an existing plot.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
boolean	allowTickAggregate	Indicates if the study allows historical and live ticks to be aggregated.
boolean	allowTickFilter	Indicates if the study allows historical and live ticks to be filtered by min and or max sizes.
boolean	autoEntry	Indicates that this strategy supports automatic entry.
boolean	barUpdatesByDefault	Indicates that Bar Updates option on on by default.
String	helpLink	HTTP Link to a website that displays documentation on this study/strategy.
String	label	Name displayed on plot label (uses name if not specified)
boolean	manualEntry	Indicates that this strategy supports manual entry.
String	menu	Menu to display this study under (optional).
String	menu2	2nd menu (optional)
String	menu3	3rd menu (optional)
boolean	multipleInstrument	Indicates if the study may request data from multiple instruments (default false).
String	rb	Resource bundle to pull translatable strings from.
boolean	requiresBarUpdates	Indicates that this study required live bar updates.
boolean	requiresBidAskHistory	Indicates that this study requires historical Bid and Ask data.
boolean	requiresUseAccountPosition	Indicates that this study requires the use of the account position.
boolean	requiresVolume	Indicates if this study requires volume data.
boolean	secured	Set this attribute to true if you would like this study to be protected by the namespace using the SDK Admin.
int	sessions	Indicates if the number of sessions supported by this strategy (default 2).
boolean	showTradeOptions	Indicates if the Trade Options panel should be shown.
boolean	signals	Indicates if this study generates signals.
boolean	strategy	Indicates that this study is a strategy.
boolean	studyOverlay	Indicates if this study can be overlaid on any plot.
boolean	supportsBarUpdates	Indicates if this study supports live bar updates.
boolean	supportsCloseOnDeactivate	Indicates if the strategy supports the 'close on deactivate' feature.
boolean	supportsCloseOnSessionEnd	Indicates if the strategy supports the 'exit on session close' feature.
boolean	supportsCurrentPL	Indicates that this strategy supports the display of the current profit/loss (strategy tag must be true).
boolean	supportsEnterOnActivate	Indicates if the strategy supports the 'enter on activate' feature.
boolean	supportsEnterOnSessionStart	Indicates if the strategy supports the 'enter on session open' feature (default false).
boolean	supportsEntryPrice	Indicates that this strategy supports the display of the entry price (strategy tag must be true).
boolean	supportsLongShort	Indicates that this strategy allows the user to choose Long or Short (strategy and manualEntry tags must be true).
boolean	supportsPosition	Indicates that this strategy supports the display of the position price (strategy tag must be true).
boolean	supportsPositionType	Indicates if the strategy supports the 'position type' feature.
boolean	supportsRealizedPL	Indicates that this strategy supports the display of the realized profit/loss (strategy tag must be true).
boolean	supportsRiskRatio	Indicates that this strategy supports the display of the risk ratio (strategy tag must be true).
boolean	supportsSessions	Indicates if the strategy supports sessions.
boolean	supportsStopPL	Indicates that this strategy supports the display of the stop profit/loss (strategy tag must be true).
boolean	supportsTargetPL	Indicates that this strategy supports the display of the target profit/loss (strategy tag must be true).
boolean	supportsTIF	Indicates if the strategy supports the order time in force (TIF) option.
boolean	supportsTotalPL	Indicates that this strategy supports the display of the total profit/loss (strategy tag must be true).
boolean	supportsTradeLots	Indicates if the strategy supports the 'trade lots' feature.
boolean	supportsUnrealizedPL	Indicates that this strategy supports the display of the unrealized profit/loss (strategy tag must be true).
boolean	supportsUseAccountPosition	Indicates if this study supports use account position.
String	tabName	Name displayed on tab (Uses label if not specified)
boolean	underlayByDefault	Indicates if this study has the underlay attribute set to true by default.

Element Details

namespace

String namespace

Namespace for this study (Must be unique for your organization)

secured

boolean secured

Set this attribute to true if you would like this study to be protected by the namespace using the SDK Admin.

Returns:

true if this study should be protected by namespace.

Default:

false

id

String id

Unique (within the namespace) ID for this study.

rb

String rb

Resource bundle to pull translatable strings from.

Default:

""

helpLink

String helpLink

HTTP Link to a website that displays documentation on this study/strategy.

Default:

""

name

String name

Displayed name of this study.

menu

String menu

Menu to display this study under (optional).

Default:

""

desc

String desc

Description displayed in the study dialog.

label

String label

Name displayed on plot label (uses name if not specified)

Default:

""

overlay

boolean overlay

Indicates if this study is an overlay that may be placed on an existing plot.

underlayByDefault

boolean underlayByDefault

Indicates if this study has the underlay attribute set to true by default.

Default:

false

studyOverlay

boolean studyOverlay

Indicates if this study can be overlaid on any plot.

Default:

false

signals

boolean signals

Indicates if this study generates signals.

Default:

false

strategy

boolean strategy

Indicates that this study is a strategy.

Returns:

true if this study is a strategy.

Default:

false

menu2

String menu2

2nd menu (optional)

Default:

""

menu3

String menu3

3rd menu (optional)

Default:

""

tabName

String tabName

Name displayed on tab (Uses label if not specified)

Default:

""

requiresVolume

boolean requiresVolume

Indicates if this study requires volume data.

Default:

false

multipleInstrument

boolean multipleInstrument

Indicates if the study may request data from multiple instruments (default false).

Returns:

true if this study may request data from multiple instruments.

Default:

false

supportsBarUpdates

boolean supportsBarUpdates

Indicates if this study supports live bar updates.

Returns:

true if this study responds to live bar updates.

Default:

true

requiresBarUpdates

boolean requiresBarUpdates

Indicates that this study required live bar updates.

Returns:

true if this study requires live bar updates.

Default:

false

barUpdatesByDefault

boolean barUpdatesByDefault

Indicates that Bar Updates option on on by default.

Returns:

true if this study has bar updates on by default.

Default:

false

allowTickAggregate

boolean allowTickAggregate

Indicates if the study allows historical and live ticks to be aggregated.

Returns:

true if historical and live ticks can be aggregated.

Default:

false

allowTickFilter

boolean allowTickFilter

Indicates if the study allows historical and live ticks to be filtered by min and or max sizes.

Returns:

true if historical and live ticks can be filtered.

Default:

false

supportsUseAccountPosition

boolean supportsUseAccountPosition

Indicates if this study supports use account position.

Returns:

true if this study supports use account position.

Default:

true

requiresUseAccountPosition

boolean requiresUseAccountPosition

Indicates that this study requires the use of the account position.

Returns:

true if this study requires the use of the account position.

Default:

false

requiresBidAskHistory

boolean requiresBidAskHistory

Indicates that this study requires historical Bid and Ask data.

Returns:

true if this study requires historical Bid and Ask data.

Default:

false

autoEntry

boolean autoEntry

Indicates that this strategy supports automatic entry.

Returns:

true if this strategy supports automatic entry (strategy tag must be true)

Default:

true

manualEntry

boolean manualEntry

Indicates that this strategy supports manual entry.

Returns:

true if this strategy supports manual entry (strategy tag must be true)

Default:

false

supportsLongShort

boolean supportsLongShort

Indicates that this strategy allows the user to choose Long or Short (strategy and manualEntry tags must be true).

Returns:

true if this strategy allows the user to choose Long or Short (strategy and manualEntry tags must be true)

Default:

true

supportsEntryPrice

boolean supportsEntryPrice

Indicates that this strategy supports the display of the entry price (strategy tag must be true).

Returns:

true if this strategy supports the display of the entry price (strategy tag must be true)

Default:

true

supportsPosition

boolean supportsPosition

Indicates that this strategy supports the display of the position price (strategy tag must be true).

Returns:

true if this strategy supports the display of the position price (strategy tag must be true)

Default:

true

supportsCurrentPL

boolean supportsCurrentPL

Indicates that this strategy supports the display of the current profit/loss (strategy tag must be true).

Returns:

true if this strategy supports the display of the current profit/loss (strategy tag must be true)

Default:

false

supportsTotalPL

boolean supportsTotalPL

Indicates that this strategy supports the display of the total profit/loss (strategy tag must be true).

Returns:

true if this strategy supports the display of the total profit/loss (strategy tag must be true)

Default:

false

supportsRiskRatio

boolean supportsRiskRatio

Indicates that this strategy supports the display of the risk ratio (strategy tag must be true).

Returns:

true if this strategy supports the display of the risk ratio (strategy tag must be true)

Default:

false

supportsStopPL

boolean supportsStopPL

Indicates that this strategy supports the display of the stop profit/loss (strategy tag must be true).

Returns:

true if this strategy supports the display of the stop profit/loss (strategy tag must be true)

Default:

false

supportsTargetPL

boolean supportsTargetPL

Indicates that this strategy supports the display of the target profit/loss (strategy tag must be true).

Returns:

true if this strategy supports the display of the target profit/loss (strategy tag must be true)

Default:

false

supportsRealizedPL

boolean supportsRealizedPL

Indicates that this strategy supports the display of the realized profit/loss (strategy tag must be true).

Returns:

true if this strategy supports the display of the realized profit/loss (strategy tag must be true)

Default:

false

supportsUnrealizedPL

boolean supportsUnrealizedPL

Indicates that this strategy supports the display of the unrealized profit/loss (strategy tag must be true).

Returns:

true if this strategy supports the display of the unrealized profit/loss (strategy tag must be true)

Default:

false

showTradeOptions

boolean showTradeOptions

Indicates if the Trade Options panel should be shown.

Returns:

true if the trade options panel should be shown.

Default:

true

supportsTradeLots

boolean supportsTradeLots

Indicates if the strategy supports the 'trade lots' feature.

Returns:

true if this strategy supports the 'trade lots' feature.

Default:

true

supportsPositionType

boolean supportsPositionType

Indicates if the strategy supports the 'position type' feature.

Returns:

true if this strategy supports the 'position type' feature.

Default:

false

supportsEnterOnActivate

boolean supportsEnterOnActivate

Indicates if the strategy supports the 'enter on activate' feature.

Returns:

true if this strategy supports the 'enter on activate' feature.

Default:

true

supportsCloseOnDeactivate

boolean supportsCloseOnDeactivate

Indicates if the strategy supports the 'close on deactivate' feature.

Returns:

true if this strategy supports the 'close on deactivate' feature.

Default:

true

supportsTIF

boolean supportsTIF

Indicates if the strategy supports the order time in force (TIF) option.

Returns:

true if this strategy supports changing the order time in force (TIF).

Default:

false

supportsSessions

boolean supportsSessions

Indicates if the strategy supports sessions.

Returns:

true if this strategy supports sessions.

Default:

true

sessions

int sessions

Indicates if the number of sessions supported by this strategy (default 2).

Returns:

number of supported sessions.

Default:

2

supportsEnterOnSessionStart

boolean supportsEnterOnSessionStart

Indicates if the strategy supports the 'enter on session open' feature (default false).

Returns:

true if this strategy supports the 'enter on session open' feature.

Default:

false

supportsCloseOnSessionEnd

boolean supportsCloseOnSessionEnd

Indicates if the strategy supports the 'exit on session close' feature.

Returns:

true if this strategy supports the 'exit on session close' feature.

Default:

true