Package de.espirit.firstspirit.opt.office

Interface OfficeImportService

public interface OfficeImportService
Since:
4.2.38

  • Field Details

  • Method Details

    • getRuleSetConfiguration

      TransformationRules getRuleSetConfiguration()
      Get the global ruleset configuration
      Returns:
      RuleSetConfiguration
      Since:
      4.2.38

    • getRuleSetConfiguration

      TransformationRules getRuleSetConfiguration(long projectID)
      Get the project ruleset configuration
      Parameters:
      projectID - the project id
      Returns:
      RuleSetConfiguration
      Since:
      4.2.38

    • setRuleSetConfiguration

      void setRuleSetConfiguration(TransformationRules ruleSet)
      Set the RuleSetConfiguration XML representation.
      Parameters:
      ruleSet - xml ruleset configuration
      Since:
      4.2.38

    • setRuleSetConfiguration

      void setRuleSetConfiguration(TransformationRules ruleSet, long projectID)
      Set the RuleSetConfiguration XML representation.
      Parameters:
      ruleSet - xml ruleset configuration
      projectID - the project id
      Since:
      4.2.38

    • getName

      @NotNull @NotNull String getName()
      Get the module name, same as in module.xml
      Returns:
      the module name string
      Since:
      4.2.38

    • isStarted

      boolean isStarted() throws de.espirit.firstspirit.server.ManagerNotFoundException
      Method to get service state in gui methods. If we cast to ServiceImpl we get Proxy cast exception.
      Returns:
      service state
      Throws:
      de.espirit.firstspirit.server.ManagerNotFoundException
      Since:
      4.2.38

    • getAvailableRulesetsFromCache

      Map<String,String> getAvailableRulesetsFromCache(long projectId) throws IOException
      Throws:
      IOException
      Since:
      4.2.38

    • getAvailableRulesets

      Map<String,String> getAvailableRulesets(long projectId) throws IOException
      Throws:
      IOException
      Since:
      4.2.38

    • getTransformationRules

      TransformationRules getTransformationRules(String rulesetName, long projectId) throws IOException
      Get the transformation rules for rule set name. 
      <ImportRuleSet name="the rule set name" description="">
      Parameters:
      rulesetName - the rule set String
      projectId - the Project.getId()
      Returns:
      TransformationRules
      Throws:
      IOException
      Since:
      4.2.38

    • getProjectConfigFileName

      String getProjectConfigFileName()
      Since:
      4.2.38

    • getRulesetConfigFileName

      String getRulesetConfigFileName()
      Since:
      4.2.38

    • getProjectProperties

      ProjectProperties getProjectProperties(long projectID)
      Since:
      4.2.38

    • setProjectProperties

      void setProjectProperties(long projectID, ProjectProperties properties)
      Since:
      4.2.38

    • clearCache

      void clearCache()
      Since:
      4.2.38