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.
  • 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

      void setCustomName(String taskName)
      Sets custom name.
      Parameters:
      taskName - the task name
    • setTitle

      void setTitle(String taskTitle)
      Sets title.
      Parameters:
      taskTitle - the task title
    • setConfig

      void setConfig(org.jdom2.Element elSettings, boolean checkChanges, boolean readSettings) throws Exception
      Sets config.
      Parameters:
      elSettings - the el settings
      checkChanges - the check changes
      readSettings - the read settings
      Throws:
      Exception - the exception
    • getConfig

      org.jdom2.Element getConfig()
      Gets config.
      Returns:
      the config
    • getDefaultConfig

      org.jdom2.Element getDefaultConfig(String defaultConfigName) throws Exception
      Gets default config.
      Parameters:
      defaultConfigName - the default config name
      Returns:
      the default config
      Throws:
      Exception - the exception
    • clone

      ISQTask clone(String projectName, ProgressEngine progressEngine) throws Exception
      Clone isq task.
      Parameters:
      projectName - the project name
      progressEngine - the progress engine
      Returns:
      the isq task
      Throws:
      Exception - the exception
    • start

      void start() throws Exception
      Start.
      Throws:
      Exception - the exception
    • afterFinish

      void afterFinish()
      After finish.
    • setTaskLogPrefix

      void setTaskLogPrefix(String prefix)
      Sets task log prefix.
      Parameters:
      prefix - the prefix
    • getErrorsDescription

      String getErrorsDescription()
      Gets errors description.
      Returns:
      the errors description
    • logTaskStarted

      void logTaskStarted(ProjectGlobalLog log)
      Log task started.
      Parameters:
      log - the log
    • logTaskFinished

      void logTaskFinished(ProjectGlobalLog log)
      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

      void setConfigFileName(String taskConfigFile)
      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

      double getCustomValue(String key)
      Gets custom value.
      Parameters:
      key - the key
      Returns:
      the custom value