Package de.espirit.firstspirit.access.export

Class ExportParameters

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    ExportParameters(long projectId, String projectName)
    Constructs a new ExportParameters object for the project specified by given id and name.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getExportCachedPictures()
    Get export cached picture resolutions state.
    boolean
    getExportDeletedElements()
    Indicates whether deleted elements should be exported or not.
    boolean
    getExportTableData()
    Indicates whether contentstore table data will be exported during the belonging project export or not.
    long
    getMaxRevisionAge()
    Get the maximum age in milliseconds of export element revisions to include in the export.
    long
    getMaxRevisionCount()
    Get the maximum count of revisions of an export element to include in the export.
    long
    getProjectId()
    Returns the project id this ExportParameters belongs to.
    String
    getProjectName()
    Returns the name of the project this ExportParameters belongs to.
    boolean
    isBackup()
    Indicates whether this export parameters belongs to a backup task.
    void
    setBackup(boolean backup)
     
    void
    setExportCachedPictures(boolean exportCachedPictures)
    Set export cached picture resolutions state.
    void
    setExportDeletedElements(boolean exportDeletedElements)
    Define whether deleted elements should be exported during belonging project export or not.
    void
    setExportTableData(boolean exportTableData)
    Define whether contentstore table data should be exported (true) during the belonging project export or not {false}.
    void
    setMaxRevisionAge(long age)
    Set the maximum age in milliseconds of export element revisions to include in the export.
    void
    setMaxRevisionCount(long count)
    Set the maximum count of revisions of an export element to include in the export.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • ExportParameters

      public ExportParameters(long projectId, String projectName)
      Constructs a new ExportParameters object for the project specified by given id and name.
      Parameters:
      projectId - the id of the project the new created export parameter should belong to
      projectName - the name of the project the new created export parameter should belong to
      Since:
      4.0.17

  • Method Details

    • getProjectId

      public long getProjectId()
      Returns the project id this ExportParameters belongs to.
      Since:
      4.0.17

    • getProjectName

      public String getProjectName()
      Returns the name of the project this ExportParameters belongs to.
      Since:
      4.0.17

    • getMaxRevisionCount

      public long getMaxRevisionCount()
      Get the maximum count of revisions of an export element to include in the export. If the count is not limited -1 is returned. If an element has fewer revisions than the given count all existing element revisions will be included.
      Returns:
      The maximum revision count of an export element to include in the export, -1 for unlimited.
      Since:
      4.0.17

    • setMaxRevisionCount

      public void setMaxRevisionCount(long count)
      Set the maximum count of revisions of an export element to include in the export. Set to -1 if the count should not be limited. If an element has fewer revisions than the given count all element revisions will be included.
      Parameters:
      count - The maximum revision count of an export element to include in the export, -1 for unlimited.
      Since:
      4.0.17

    • getMaxRevisionAge

      public long getMaxRevisionAge()
      Get the maximum age in milliseconds of export element revisions to include in the export. If the age is not limited, -1 is returned. At least one revision of each export element will be included, even if it is older.
      Returns:
      The maximum age in milliseconds of export element revisions to include in the export, -1 for unlimited.
      Since:
      4.0.17

    • setMaxRevisionAge

      public void setMaxRevisionAge(long age)
      Set the maximum age in milliseconds of export element revisions to include in the export. If the age is not limited, -1 is returned. At least one revision of each export element will be included, even if it is older.
      Parameters:
      age - The maximum age in milliseconds of export element revisions to include in the export, -1 for unlimited.
      Since:
      4.0.17

    • isBackup

      public boolean isBackup()
      Indicates whether this export parameters belongs to a backup task.
      Since:
      4.0.17
      See Also:

    • setBackup

      public void setBackup(boolean backup)
      Since:
      4.0.17

    • getExportDeletedElements

      public boolean getExportDeletedElements()
      Indicates whether deleted elements should be exported or not.
      Since:
      4.0.25
      See Also:

    • setExportDeletedElements

      public void setExportDeletedElements(boolean exportDeletedElements)
      Define whether deleted elements should be exported during belonging project export or not.
      Parameters:
      exportDeletedElements - use true to activate export of deleted elements, false otherwise
      Since:
      4.0.25
      See Also:

    • getExportTableData

      public boolean getExportTableData()
      Indicates whether contentstore table data will be exported during the belonging project export or not.
      Since:
      4.0.75
      See Also:

    • setExportTableData

      public void setExportTableData(boolean exportTableData)
      Define whether contentstore table data should be exported (true) during the belonging project export or not {false}.
      Parameters:
      exportTableData - use true to activate contentstore table data export, false otherwise
      Since:
      4.0.75
      See Also:

    • getExportCachedPictures

      public boolean getExportCachedPictures()
      Get export cached picture resolutions state. Cached picture resolutions often take a lot of space and will be created on demand, if they are missing. Default behavior is including the cached picture resolutions in a export.
      Returns:
      True if cached pictures should be exported
      Since:
      5.2.201

    • setExportCachedPictures

      public void setExportCachedPictures(boolean exportCachedPictures)
      Set export cached picture resolutions state. Cached picture resolutions often take a lot of space and will be created on demand, if they are missing.
      Parameters:
      exportCachedPictures - True if cached pictures should be exported
      Since:
      5.2.201