Interface ISQTask
- All Superinterfaces:
com.strategyquant.pluginlib.ISQPlugin
,net.xeoh.plugins.base.Plugin
- All Known Implementing Classes:
AbstractTask
public interface ISQTask
extends com.strategyquant.pluginlib.ISQPlugin
The interface Isq task.
-
Field Summary
Fields inherited from interface com.strategyquant.pluginlib.ISQPlugin
PositionComparator
-
Method Summary
Modifier and TypeMethodDescriptionvoid
After finish.clone(String projectName, ProgressEngine progressEngine)
Clone isq task.org.jdom2.Element
Gets config.Gets custom name.double
getCustomValue(String key)
Gets custom value.org.jdom2.Element
getDefaultConfig(String defaultConfigName)
Gets default config.Gets errors description.int
getIndex()
Gets index.getName()
Gets name.int
Gets number of runs.Gets plugin folder name.String[]
Get settings string [ ].Gets settings data.Gets task xml file name.getTitle()
Gets title.getType()
Gets type.void
Increase number of runs.boolean
isActive()
Is active boolean.void
Log task finished.void
Log task started.void
setActive(boolean active)
Sets active.void
setConfig(org.jdom2.Element elSettings, boolean checkChanges, boolean readSettings)
Sets config.void
setConfigFileName(String taskConfigFile)
Sets config file name.void
setCustomName(String taskName)
Sets custom name.void
setIndex(int index)
Sets index.void
setTaskLogPrefix(String prefix)
Sets task log prefix.void
Sets title.void
start()
Start.Methods inherited from interface com.strategyquant.pluginlib.ISQPlugin
getPreferredPosition, getProduct, initPlugin
-
Method Details
-
getType
String getType()Gets type.- Returns:
- the type
-
getName
String getName()Gets name.- Returns:
- the name
-
getPluginFolderName
String getPluginFolderName()Gets plugin folder name.- Returns:
- the plugin folder name
-
getCustomName
String getCustomName()Gets custom name.- Returns:
- the custom name
-
getTitle
String getTitle()Gets title.- Returns:
- the title
-
isActive
boolean isActive()Is active boolean.- Returns:
- the boolean
-
setActive
void setActive(boolean active)Sets active.- Parameters:
active
- the active
-
getSettings
String[] getSettings()Get settings string [ ].- Returns:
- the string [ ]
-
getSettingsData
TaskSettingsData getSettingsData()Gets settings data.- Returns:
- the settings data
-
setCustomName
Sets custom name.- Parameters:
taskName
- the task name
-
setTitle
Sets title.- Parameters:
taskTitle
- the task title
-
setConfig
void setConfig(org.jdom2.Element elSettings, boolean checkChanges, boolean readSettings) throws ExceptionSets config.- Parameters:
elSettings
- the el settingscheckChanges
- the check changesreadSettings
- the read settings- Throws:
Exception
- the exception
-
getConfig
org.jdom2.Element getConfig()Gets config.- Returns:
- the config
-
getDefaultConfig
Gets default config.- Parameters:
defaultConfigName
- the default config name- Returns:
- the default config
- Throws:
Exception
- the exception
-
clone
Clone isq task.- Parameters:
projectName
- the project nameprogressEngine
- the progress engine- Returns:
- the isq task
- Throws:
Exception
- the exception
-
start
Start.- Throws:
Exception
- the exception
-
afterFinish
void afterFinish()After finish. -
setTaskLogPrefix
Sets task log prefix.- Parameters:
prefix
- the prefix
-
getErrorsDescription
String getErrorsDescription()Gets errors description.- Returns:
- the errors description
-
logTaskStarted
Log task started.- Parameters:
log
- the log
-
logTaskFinished
Log task finished.- Parameters:
log
- the log
-
increaseNumberOfRuns
void increaseNumberOfRuns()Increase number of runs. -
getNumberOfRuns
int getNumberOfRuns()Gets number of runs.- Returns:
- the number of runs
-
getIndex
int getIndex()Gets index.- Returns:
- the index
-
setIndex
void setIndex(int index)Sets index.- Parameters:
index
- the index
-
setConfigFileName
Sets config file name.- Parameters:
taskConfigFile
- the task config file
-
getTaskXMLFileName
String getTaskXMLFileName()Gets task xml file name.- Returns:
- the task xml file name
-
getCustomValue
Gets custom value.- Parameters:
key
- the key- Returns:
- the custom value
-