Interface ProjectCleanupTask
- All Superinterfaces:
ScheduleTask
Task for archiving project repository files.
- Since:
- 5.2.903
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic enum
Version history archiving mode. -
Method Summary
Modifier and TypeMethodDescriptionint
Returns the minimum number of days of version history to keep onpartial cleanup
.boolean
Returns whether or not content and media stores are to be archived.boolean
Returns whether or not the template store is to be ignored for this cleanup task.boolean
Returns whether or not the maximum run-time of this task is to be limited.int
Returns the maximum allowed run-time of this task.@NotNull ProjectCleanupTask.Mode
getMode()
Returns the cleanup mode.boolean
Returns whether or not deleted elements are to be archived.boolean
Returns whether or not system data is to be archived.boolean
Returns whether or not no longer required version history is to be archived.long
Returns the delay between archiving steps.boolean
Returns whether or not archiving is to be throttled.void
setCleanupAge
(int age) Sets the number of days of version history to keep onpartial cleanup
.void
setIgnoreContentAndMedia
(boolean ignore) Defines whether or not content and media stores are to be archived.void
setIgnoreTemplateStore
(boolean ignore) Defines whether or not the template store is to be ignored for this cleanup task.void
setLimitDuration
(boolean limitDuration) Defines whether or not the maximum run-time of this task is to be limited.void
setMaxDuration
(int minutes) Defines the maximum allowed run-time of this task.void
setMode
(@NotNull ProjectCleanupTask.Mode mode) Defines the cleanup mode.void
setRemoveDeletedElements
(boolean removeDeletedElements) Defines whether or not deleted elements are to be archived.void
setRemoveInternalFiles
(boolean remove) Defines whether or not system data is to be archived.void
setRemoveOldElements
(boolean removeOldElements) Defines whether or not no longer required version history is to be archived.void
setThrottleTime
(long throttleTime) Defines the delay between archiving steps.void
setUseThrottling
(boolean throttling) Defines whether or not archiving is to be throttled.Methods inherited from interface de.espirit.firstspirit.access.schedule.ScheduleTask
checkParams, getClusterNodeName, getDescription, getExecuteInFault, getExecuteParallel, getName, getRemoteTaskType, getScheduleEntry, getTemplate, hasTemplate, isActive, isExecuteOnClusterNode, isProjectTask, setActive, setClusterNodeName, setDescription, setExecuteInFault, setExecuteOnClusterNode, setExecuteParallel, setName, setTemplate, test
-
Method Details
-
getCleanupAge
int getCleanupAge()Returns the minimum number of days of version history to keep onpartial cleanup
.- Returns:
- The minimum number of days of version history to keep.
- Since:
- 5.2.903
- See Also:
-
setCleanupAge
void setCleanupAge(int age) Sets the number of days of version history to keep onpartial cleanup
.- Parameters:
age
- The minimum number of days of version history to keep.- Since:
- 5.2.903
- See Also:
-
getRemoveDeletedElements
boolean getRemoveDeletedElements()Returns whether or not deleted elements are to be archived.- Returns:
- Whether or not deleted elements are to be archived.
- Since:
- 5.2.903
-
setRemoveDeletedElements
void setRemoveDeletedElements(boolean removeDeletedElements) Defines whether or not deleted elements are to be archived.- Parameters:
removeDeletedElements
-true
if deleted elements are to be archived,false
otherwise.- Since:
- 5.2.903
-
getRemoveOldElements
boolean getRemoveOldElements()Returns whether or not no longer required version history is to be archived.- Returns:
true
if no longer required version history are to be archived,false
otherwise.- Since:
- 5.2.903
-
setRemoveOldElements
void setRemoveOldElements(boolean removeOldElements) Defines whether or not no longer required version history is to be archived.- Parameters:
removeOldElements
-true
if no longer required version history are to be archived,false
otherwise.- Since:
- 5.2.903
-
getIgnoreTemplateStore
boolean getIgnoreTemplateStore()Returns whether or not the template store is to be ignored for this cleanup task.- Returns:
true
if template store elements are to be ignored,false
otherwise- Since:
- 5.2.903
- See Also:
-
setIgnoreTemplateStore
void setIgnoreTemplateStore(boolean ignore) Defines whether or not the template store is to be ignored for this cleanup task.- Parameters:
ignore
-true
if template store elements are to be ignored,false
otherwise- Since:
- 5.2.903
- See Also:
-
getRemoveInternalFiles
boolean getRemoveInternalFiles()Returns whether or not system data is to be archived.- Returns:
true
if system data is to be archived,false
otherwise.- Since:
- 5.2.903
-
setRemoveInternalFiles
void setRemoveInternalFiles(boolean remove) Defines whether or not system data is to be archived.- Parameters:
remove
-true
if system data is to be archived,false
otherwise.- Since:
- 5.2.903
-
getMode
Returns the cleanup mode.- Returns:
- The cleanup mode.
- Since:
- 5.2.903
-
setMode
Defines the cleanup mode.- Parameters:
mode
- The cleanup mode.- Since:
- 5.2.903
-
getIgnoreContentAndMedia
boolean getIgnoreContentAndMedia()Returns whether or not content and media stores are to be archived.- Returns:
true
if content and media stores are not to be archived,false
otherwise.- Since:
- 5.2.903
-
setIgnoreContentAndMedia
void setIgnoreContentAndMedia(boolean ignore) Defines whether or not content and media stores are to be archived.- Parameters:
ignore
-true
if content and media stores are not to be archived,false
otherwise.- Since:
- 5.2.903
-
getLimitDuration
boolean getLimitDuration()Returns whether or not the maximum run-time of this task is to be limited.- Returns:
true
if the maximum run-time of this task is to be limited,false
otherwise.- Since:
- 5.2.903
- See Also:
-
setLimitDuration
void setLimitDuration(boolean limitDuration) Defines whether or not the maximum run-time of this task is to be limited.- Parameters:
limitDuration
-true
if the maximum run-time of this task is to be limited,false
otherwise.- Since:
- 5.2.903
- See Also:
-
getMaxDuration
int getMaxDuration()Returns the maximum allowed run-time of this task.- Returns:
- The maximum allowed run-time of this task in minutes.
-1
means unlimited. - Since:
- 5.2.903
- See Also:
-
setMaxDuration
void setMaxDuration(int minutes) Defines the maximum allowed run-time of this task.- Parameters:
minutes
- The maximum allowed run-time of this task in minutes. Pass-1
for unlimited.- Since:
- 5.2.903
- See Also:
-
getUseThrottling
boolean getUseThrottling()Returns whether or not archiving is to be throttled.- Returns:
true
if the archiving is to be throttled,false
otherwise.- Since:
- 5.2.903
- See Also:
-
setUseThrottling
void setUseThrottling(boolean throttling) Defines whether or not archiving is to be throttled.- Parameters:
throttling
-true
if the archiving is to be throttled,false
otherwise.- Since:
- 5.2.903
- See Also:
-
getThrottleTime
long getThrottleTime()Returns the delay between archiving steps.- Returns:
- The delay between archiving steps in milliseconds.
- Since:
- 5.2.903
- See Also:
-
setThrottleTime
void setThrottleTime(long throttleTime) Defines the delay between archiving steps.- Parameters:
throttleTime
- The delay between archiving steps in milliseconds.- Since:
- 5.2.903
- See Also:
-