Package de.elo.ix.client

Class PurgeSettings

java.lang.Object
byps.BValueClass
de.elo.ix.client.ValueClass
de.elo.ix.client.PurgeSettings
All Implemented Interfaces:
Serializable
public class PurgeSettings extends ValueClass implements Serializable
This class represents the purge settings of the ELOdm purge task
Since:
8.00.032.002
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected int
    dayLimit
    Original documents older than the specified number of days are deleted (0 or higher), e.g.
    protected List<Integer>
    excludePathIds
    List of path ids to exclude from purging if pathId=0 is set.
    protected int
    fileCheckMode
    The original and the backup document can be compared before cleanup.
    protected int
    pathId
    Possible path restriction for filing paths:
    0: include all paths
    1 and higher: only include a path with this ID where documents should be deleted
    protected int
    startHour
    When processing should take place:
    START_EVERY_HOUR: when the purge task is starting and then every 60 minutes
    0 to 23: hour of the day, such as 8:00 p.m.

    Fields inherited from class byps.BValueClass

    bypsClient, changedMembers, dbHelper, FLAG_SEALED, flags

  • Constructor Summary

    Constructors
    Constructor
    Description
    PurgeSettings()
     
    PurgeSettings(int dayLimit, int pathId, int fileCheckMode, int startHour)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getDayLimit()
     
    List<Integer>
    getExcludePathIds()
     
    int
    getFileCheckMode()
     
    int
    getPathId()
     
    int
    getStartHour()
     
    void
    setDayLimit(int dayLimit)
     
    void
    setExcludePathIds(List<Integer> excludePathIds)
     
    void
    setFileCheckMode(int fileCheckMode)
     
    void
    setPathId(int pathId)
     
    void
    setStartHour(int startHour)
     
    String
    toString()
     

    Methods inherited from class byps.BValueClass

    getBypsClient, getChangedMembers, getDbHelper, isChangedMember, isSealed, seal, seal, setBypsClient, setChangedMember, setChangedMembers, setDbHelper

    Methods inherited from class java.lang.Object

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

  • Field Details

    • dayLimit

      protected int dayLimit
      Original documents older than the specified number of days are deleted (0 or higher), e.g. 0 for no limit, 1 for 24 hours, 365 for a year

    • pathId

      protected int pathId
      Possible path restriction for filing paths:
      0: include all paths
      1 and higher: only include a path with this ID where documents should be deleted

    • fileCheckMode

      protected int fileCheckMode
      The original and the backup document can be compared before cleanup. Possible values (1 to 3) are defined in PurgeSettingsC.

    • startHour

      protected int startHour
      When processing should take place:
      START_EVERY_HOUR: when the purge task is starting and then every 60 minutes
      0 to 23: hour of the day, such as 8:00 p.m.

    • excludePathIds

      protected List<Integer> excludePathIds
      List of path ids to exclude from purging if pathId=0 is set.
      Since:
      9.00.000.027

  • Constructor Details

    • PurgeSettings

      public PurgeSettings()

    • PurgeSettings

      public PurgeSettings(int dayLimit, int pathId, int fileCheckMode, int startHour)

  • Method Details

    • getDayLimit

      public int getDayLimit()

    • setDayLimit

      public void setDayLimit(int dayLimit)

    • getPathId

      public int getPathId()

    • setPathId

      public void setPathId(int pathId)

    • getFileCheckMode

      public int getFileCheckMode()

    • setFileCheckMode

      public void setFileCheckMode(int fileCheckMode)

    • getStartHour

      public int getStartHour()

    • setStartHour

      public void setStartHour(int startHour)

    • getExcludePathIds

      public List<Integer> getExcludePathIds()

    • setExcludePathIds

      public void setExcludePathIds(List<Integer> excludePathIds)

    • toString

      public String toString()
      Overrides:
      toString in class Object