Package de.espirit.firstspirit.access.export

Class ImportParameters

java.lang.Object
de.espirit.firstspirit.access.export.ImportParameters
All Implemented Interfaces:
Serializable
public class ImportParameters extends Object implements Serializable
Configuration class used as parameter for project imports
Since:
4.0.17
See Also:

  • Constructor Details

  • Method Details

    • getExportFile

      public ExportFile getExportFile()
      Returns the belonging export file.
      Since:
      4.0.17

    • getProjectInfo

      public ProjectInfo getProjectInfo()
      Returns the belonging project info.
      Since:
      4.0.17

    • getProjectName

      public String getProjectName()
      Gets the name of the new project which will be created during the project import.
      Since:
      4.0.17

    • getProjectDescription

      public String getProjectDescription()
      Gets the description of the new project which will be created during the project import.
      Since:
      4.0.17

    • getLayerMapping

      public Map<String,String> getLayerMapping()
      Is used in addition to getLayerIDMapping().
      Returns:
      map of old layername to new layername
      Since:
      4.0.17

    • getLayerIDMapping

      public Map<Long,String> getLayerIDMapping()
      Is used in addition to getLayerMapping().
      Returns:
      map of old schema id to new layername
      Since:
      4.2.9

    • getCreateNewIds

      public boolean getCreateNewIds()
      Indicates whether the project importwill create new ids ( true, default) or keeps the ids existing in the export file.
      Since:
      4.0.17
      See Also:

    • setCreateNewIds

      public void setCreateNewIds(boolean createNewIds)
      Define whether the project importshould create new ids (default) or keep the ids existing in the export file.
      Since:
      4.0.17
      See Also:

    • getActivateDeployments

      public boolean getActivateDeployments()
      Indicates whether schedule entries imported during theproject import will be activated (default) or not.
      Returns:
      true (default) if schedule entries will be activated during project import, false otherwise
      Since:
      4.0.17
      See Also:

    • setActivateDeployments

      public void setActivateDeployments(boolean activateDeployments)
      Define whether schedule entries imported during theproject import should be activated (default) or not.
      Parameters:
      activateDeployments - true to activate schedule entries during import
      Since:
      4.0.17
      See Also:

    • getScheduleTaskTemplateMapping

      public Map<Long,Long> getScheduleTaskTemplateMapping()
      Returns:
      returns a map containing the mapping for server depending schedule task templates to import.
      the keyrepresents the id of the template to import, the value is the template id schedule tasks should reference after import.
      if the schedule task template should be imported the value is set to -1.
      Since:
      4.0.17

    • getActivateProject

      public boolean getActivateProject()
      Indicates whether the imported project will be activated after the project import (default) or not.
      Returns:
      true (default) if the project will be activated after the import, false otherwise
      Since:
      4.1.22
      See Also:

    • setActivateProject

      public void setActivateProject(boolean activateProject)
      Define whether the imported project should be activated after project importor not.
      Parameters:
      activateProject - use true if the new created/imported project should be active after import, false otherwise
      Since:
      4.1.22
      See Also:

    • getRestoreProjectId

      public long getRestoreProjectId()
      Restore project mode. Keep project id an import old ProjectDTO. Useful for restoring a project on the same server. -1 means normal import mode (create new project with new id).
      Since:
      4.2.9

    • setRestoreProjectId

      public void setRestoreProjectId(long restoreProjectId)
      Since:
      4.2.9

    • getBackupRestore

      public boolean getBackupRestore()
      Returns true if this import is a project backup restore. A project backup restore has some limitations, for example a change of the database layer type is not possible.
      Returns:
      true if this is a project backup restore
      Since:
      5.0.107

    • setBackupRestore

      public void setBackupRestore(boolean backupRestore)
      Set to true if this import is a project backup restore. A project backup restore has some limitations, for example a change of the database layer type is not possible.
      Parameters:
      backupRestore - set to true if this is a project backup restore
      Since:
      5.0.107

    • getCheckFreeSpace

      public boolean getCheckFreeSpace()
      Returns true if a check for sufficient free disk space is performed on the server before the import process is started to make sure the import completes successfully. This is a best effort check and there are multiple factors which make it difficult to exactly calculate the disk space needed by a project, therefore it is possible to deactivate the check completely.
      Returns:
      true if a check for sufficient free disk space on the server should be performed before the import process is started.
      Since:
      5.2.220606

    • setCheckFreeSpace

      public void setCheckFreeSpace(boolean checkFreeSpace)
      Set to true if a check for sufficient free disk space on the server should be performed before the import process is started. There are multiple factors which make it difficult to exactly calculate the disk space needed by a project, therefore it is possible to deactivate the check completely.
      Parameters:
      checkFreeSpace - set to true if a check for sufficient free disk space on the server should be performed before the import process is started.
      Since:
      5.2.220606

    • toString

      public String toString()
      Overrides:
      toString in class Object
      Since:
      4.0.17