public interface ProjectCleanupTask extends ScheduleTask
Modifier and Type | Interface and Description |
---|---|
static class |
ProjectCleanupTask.Mode
Version history archiving mode.
|
Modifier and Type | Method and Description |
---|---|
int |
getCleanupAge()
Returns the minimum number of days of version history to keep on
partial cleanup . |
boolean |
getIgnoreContentAndMedia()
Returns whether or not content and media stores are to be archived.
|
boolean |
getIgnoreTemplateStore()
Returns whether or not the template store is to be ignored for this cleanup task.
|
boolean |
getLimitDuration()
Returns whether or not the maximum run-time of this task is to be limited.
|
int |
getMaxDuration()
Returns the maximum allowed run-time of this task.
|
ProjectCleanupTask.Mode |
getMode()
Returns the cleanup mode.
|
boolean |
getRemoveDeletedElements()
Returns whether or not deleted elements are to be archived.
|
boolean |
getRemoveInternalFiles()
Returns whether or not system data is to be archived.
|
boolean |
getRemoveOldElements()
Returns whether or not no longer required version history is to be archived.
|
long |
getThrottleTime()
Returns the delay between archiving steps.
|
boolean |
getUseThrottling()
Returns whether or not archiving is to be throttled.
|
void |
setCleanupAge(int age)
Sets the number of days of version history to keep on
partial 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(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.
|
checkParams, getClusterNodeName, getDescription, getExecuteInFault, getExecuteParallel, getName, getRemoteTaskType, getScheduleEntry, getTemplate, hasTemplate, isActive, isExecuteOnClusterNode, isProjectTask, setActive, setClusterNodeName, setDescription, setExecuteInFault, setExecuteOnClusterNode, setExecuteParallel, setName, setTemplate, test
int getCleanupAge()
partial cleanup
.setMode(Mode)
,
ProjectCleanupTask.Mode.PARTIAL_CLEANUP
void setCleanupAge(int age)
partial cleanup
.age
- The minimum number of days of version history to keep.setMode(Mode)
,
ProjectCleanupTask.Mode.PARTIAL_CLEANUP
boolean getRemoveDeletedElements()
void setRemoveDeletedElements(boolean removeDeletedElements)
removeDeletedElements
- true
if deleted elements are to be archived, false
otherwise.boolean getRemoveOldElements()
true
if no longer required version history are to be archived, false
otherwise.void setRemoveOldElements(boolean removeOldElements)
removeOldElements
- true
if no longer required version history are to be archived, false
otherwise.boolean getIgnoreTemplateStore()
true
if template store elements are to be ignored, false
otherwisesetIgnoreTemplateStore(boolean)
void setIgnoreTemplateStore(boolean ignore)
ignore
- true
if template store elements are to be ignored, false
otherwisegetIgnoreTemplateStore()
boolean getRemoveInternalFiles()
true
if system data is to be archived, false
otherwise.void setRemoveInternalFiles(boolean remove)
remove
- true
if system data is to be archived, false
otherwise.@NotNull ProjectCleanupTask.Mode getMode()
void setMode(@NotNull ProjectCleanupTask.Mode mode)
mode
- The cleanup mode.boolean getIgnoreContentAndMedia()
true
if content and media stores are not to be archived, false
otherwise.void setIgnoreContentAndMedia(boolean ignore)
ignore
- true
if content and media stores are not to be archived, false
otherwise.boolean getLimitDuration()
true
if the maximum run-time of this task is to be limited, false
otherwise.getMaxDuration()
,
setMaxDuration(int)
void setLimitDuration(boolean limitDuration)
limitDuration
- true
if the maximum run-time of this task is to be limited, false
otherwise.getMaxDuration()
,
setMaxDuration(int)
int getMaxDuration()
-1
means unlimited.getLimitDuration()
,
setLimitDuration(boolean)
void setMaxDuration(int minutes)
minutes
- The maximum allowed run-time of this task in minutes. Pass -1
for unlimited.getLimitDuration()
,
setLimitDuration(boolean)
boolean getUseThrottling()
true
if the archiving is to be throttled, false
otherwise.getThrottleTime()
,
setThrottleTime(long)
void setUseThrottling(boolean throttling)
throttling
- true
if the archiving is to be throttled, false
otherwise.getThrottleTime()
,
setThrottleTime(long)
long getThrottleTime()
getUseThrottling()
,
setUseThrottling(boolean)
void setThrottleTime(long throttleTime)
throttleTime
- The delay between archiving steps in milliseconds.getUseThrottling()
,
setUseThrottling(boolean)
Copyright © 2021 e-Spirit AG. All Rights Reserved. Build 5.2.210210