All Known Implementing Classes:

DataRetentionManagementServiceImpl
```
public interface IDataRetentionManagementService
```
Provides an interface for submission data purge service.

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`PARAM_ENFORCE_GLOBAL_THRESHOLD`	The 'enforceGlobalThreshold' parameter name.
`static String`	`PARAM_MAX_AUDIT_LOG_AGE_DAYS`	The 'maxAuditLogAgeDays' parameter name.
`static String`	`PARAM_MAX_COLLABORATION_JOB_AGE_DAYS`	The 'maxCollaborationJobAgeDays' parameter name.
`static String`	`PARAM_MAX_DELIVERED_SUBMISSION_DATA_AGE_DAYS`	The 'maxDeliveredSubmissionDataAgeDays' parameter name.
`static String`	`PARAM_MAX_EMAIL_QUEUE_AGE_DAYS`	The 'maxEmailQueueAgeDays' parameter name.
`static String`	`PARAM_MAX_ERROR_LOG_AGE_DAYS`	The 'maxErrorLogAgeDays' parameter name.
`static String`	`PARAM_MAX_EVENT_LOG_AGE_DAYS`	The 'maxEventLogAgeDays' parameter name.
`static String`	`PARAM_MAX_GROOVY_SERVICE_LOG_AGE_DAYS`	The 'maxGroovyServiceLogAgeDays' parameter name.
`static String`	`PARAM_MAX_OFFLINE_SYNC_LOG_AGE_DAYS`	The 'maxOfflineSyncLogAgeDays' parameter name.
`static String`	`PARAM_MAX_SAVED_SUBMISSION_AGE_DAYS`	The 'maxSavedSubmissionAgeDays' parameter name.
`static String`	`PARAM_MAX_SCHEDULED_JOB_HISTORY_AGE_DAYS`	The 'maxScheduledJobHistoryAgeDays' parameter name.
`static String`	`PARAM_MAX_SECURITY_MANAGER_LOG_AGE_DAYS`	The 'maxSecurityManagerLogAgeDays' parameter name.
`static String`	`PARAM_MAX_SUBMISSION_LOG_AGE_DAYS`	The 'maxSubmissionLogAgeDays' parameter name.
`static String`	`PARAM_MAX_TRANSACTION_HISTORY_AGE_DAYS`	The 'maxSubmissionLogMetricsAgeDays' parameter name.
`static String`	`PARAM_MAX_USER_AUTH_EVENT_AGE_DAYS`	The 'maxUserAuthEventAgeDays' parameter name.
`static String`	`PARAM_PII_SEARCH_PURGE_MODE`	the 'piiSearchPurgeMode' parameter name.
`static String`	`PARAM_PII_SEARCH_PURGE_MODE_PURGE_TIME`	The PII Search Setting value Purge Time.
`static String`	`PII_SEARCH_PURGE_MODE_DELIVERY_COMPLETED`	The PII Search Setting value Delivery Completed.
`static String`	`PII_SEARCH_PURGE_MODE_FORM_COMPLETED`	The PII Search Setting value Form Status Completed.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`int`	`applyDataRetentionPolicy(int purgeTxnsFetchLimit, int maxPeriodSec)`	Apply data retention policies and return the number of records deleted.
`int`	`getMaxAuditLogAgeDays()`	Return the age in days at which an audit log entry becomes eligible for purging.
`int`	`getMaxCollaborationJobAgeDays()`	Return the maximum age (in days) of collaboration jobs and all associated entities such as job steps, job actions and submissions.
`int`	`getMaxDeliveredSubmissionDataAgeDays()`	Return the max delivered submission data age in days.
`int`	`getMaxEmailQueueAgeDays()`	Return the max email queue age days.
`int`	`getMaxErrorLogAgeDays()`	Return the age in days at which an error log entry becomes eligible for purging.
`int`	`getMaxEventLogAgeDays()`	Return the age in days at which an event log entry becomes eligible for purging.
`int`	`getMaxGroovyServiceLogAgeDays()`	Return the age in days at which a groovy service log entry becomes eligible for purging.
`int`	`getMaxImportLogAgeDays()`	Return the max import log age days.
`int`	`getMaxOfflineSyncLogAgeDays()`	Return the age in days at which a Field Worker sync log entry becomes eligible for purging.
`int`	`getMaxSavedSubmissionAgeDays()`	Return the max saved submission data age days.
`int`	`getMaxScheduledJobHistoryAgeDays()`	Return the age in days at which a scheduled job history entry becomes eligible for purging.
`int`	`getMaxSecurityManagerLogAgeDays()`	Return the age in days at which a security manager log entry becomes eligible for purging.
`int`	`getMaxServerHealthLogAgeDays()`	Return the age in days at which a server health log entry becomes eligible for purging.
`int`	`getMaxSubmissionLogAgeDays()`	Return the max submission log age days.
`int`	`getMaxTransactionHistoryAgeDays()`	Return the maximum age of the transaction history in days.
`int`	`getMaxUserAuthEventAgeDays()`	Return the age in days at which a user authentication event becomes eligible for purging.
`String`	`getPiiSearchPurgeMode()`
`boolean`	`isEnforceGlobalThreshold()`	Return whether the service is configured to enforce global policies over organization and form level policies.
`void`	`setLogToEventLog(boolean value)`	Specify whether to log the results of the data retention job to the event log.

- Field Detail
  - PARAM_MAX_AUDIT_LOG_AGE_DAYS
```
static final String PARAM_MAX_AUDIT_LOG_AGE_DAYS
```
    The 'maxAuditLogAgeDays' parameter name.
    
    See Also:
    
    Constant Field Values
  - PARAM_MAX_COLLABORATION_JOB_AGE_DAYS
```
static final String PARAM_MAX_COLLABORATION_JOB_AGE_DAYS
```
    The 'maxCollaborationJobAgeDays' parameter name.
    
    See Also:
    
    Constant Field Values
  - PARAM_MAX_EMAIL_QUEUE_AGE_DAYS
```
static final String PARAM_MAX_EMAIL_QUEUE_AGE_DAYS
```
    The 'maxEmailQueueAgeDays' parameter name.
    
    See Also:
    
    Constant Field Values
  - PARAM_MAX_ERROR_LOG_AGE_DAYS
```
static final String PARAM_MAX_ERROR_LOG_AGE_DAYS
```
    The 'maxErrorLogAgeDays' parameter name.
    
    See Also:
    
    Constant Field Values
  - PARAM_MAX_EVENT_LOG_AGE_DAYS
```
static final String PARAM_MAX_EVENT_LOG_AGE_DAYS
```
    The 'maxEventLogAgeDays' parameter name.
    
    See Also:
    
    Constant Field Values
  - PARAM_MAX_GROOVY_SERVICE_LOG_AGE_DAYS
```
static final String PARAM_MAX_GROOVY_SERVICE_LOG_AGE_DAYS
```
    The 'maxGroovyServiceLogAgeDays' parameter name.
    
    See Also:
    
    Constant Field Values
  - PARAM_MAX_OFFLINE_SYNC_LOG_AGE_DAYS
```
static final String PARAM_MAX_OFFLINE_SYNC_LOG_AGE_DAYS
```
    The 'maxOfflineSyncLogAgeDays' parameter name.
    
    See Also:
    
    Constant Field Values
  - PARAM_MAX_SCHEDULED_JOB_HISTORY_AGE_DAYS
```
static final String PARAM_MAX_SCHEDULED_JOB_HISTORY_AGE_DAYS
```
    The 'maxScheduledJobHistoryAgeDays' parameter name.
    
    See Also:
    
    Constant Field Values
  - PARAM_MAX_SECURITY_MANAGER_LOG_AGE_DAYS
```
static final String PARAM_MAX_SECURITY_MANAGER_LOG_AGE_DAYS
```
    The 'maxSecurityManagerLogAgeDays' parameter name.
    
    See Also:
    
    Constant Field Values
  - PARAM_MAX_SUBMISSION_LOG_AGE_DAYS
```
static final String PARAM_MAX_SUBMISSION_LOG_AGE_DAYS
```
    The 'maxSubmissionLogAgeDays' parameter name.
    
    See Also:
    
    Constant Field Values
  - PARAM_MAX_SAVED_SUBMISSION_AGE_DAYS
```
static final String PARAM_MAX_SAVED_SUBMISSION_AGE_DAYS
```
    The 'maxSavedSubmissionAgeDays' parameter name.
    
    See Also:
    
    Constant Field Values
  - PARAM_MAX_TRANSACTION_HISTORY_AGE_DAYS
```
static final String PARAM_MAX_TRANSACTION_HISTORY_AGE_DAYS
```
    The 'maxSubmissionLogMetricsAgeDays' parameter name.
    
    See Also:
    
    Constant Field Values
  - PARAM_MAX_DELIVERED_SUBMISSION_DATA_AGE_DAYS
```
static final String PARAM_MAX_DELIVERED_SUBMISSION_DATA_AGE_DAYS
```
    The 'maxDeliveredSubmissionDataAgeDays' parameter name.
    
    See Also:
    
    Constant Field Values
  - PARAM_MAX_USER_AUTH_EVENT_AGE_DAYS
```
static final String PARAM_MAX_USER_AUTH_EVENT_AGE_DAYS
```
    The 'maxUserAuthEventAgeDays' parameter name.
    
    See Also:
    
    Constant Field Values
  - PARAM_ENFORCE_GLOBAL_THRESHOLD
```
static final String PARAM_ENFORCE_GLOBAL_THRESHOLD
```
    The 'enforceGlobalThreshold' parameter name.
    
    See Also:
    
    Constant Field Values
  - PARAM_PII_SEARCH_PURGE_MODE
```
static final String PARAM_PII_SEARCH_PURGE_MODE
```
    the 'piiSearchPurgeMode' parameter name.
    
    See Also:
    
    Constant Field Values
  - PII_SEARCH_PURGE_MODE_FORM_COMPLETED
```
static final String PII_SEARCH_PURGE_MODE_FORM_COMPLETED
```
    The PII Search Setting value Form Status Completed.
    
    See Also:
    
    Constant Field Values
  - PII_SEARCH_PURGE_MODE_DELIVERY_COMPLETED
```
static final String PII_SEARCH_PURGE_MODE_DELIVERY_COMPLETED
```
    The PII Search Setting value Delivery Completed.
    
    See Also:
    
    Constant Field Values
  - PARAM_PII_SEARCH_PURGE_MODE_PURGE_TIME
```
static final String PARAM_PII_SEARCH_PURGE_MODE_PURGE_TIME
```
    The PII Search Setting value Purge Time.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - applyDataRetentionPolicy
```
int applyDataRetentionPolicy(int purgeTxnsFetchLimit,
                             int maxPeriodSec)
```
    Apply data retention policies and return the number of records deleted.
    
    Parameters:
    
    purgeTxnsFetchLimit - the fast mode purge transactions fetch limit
    
    maxPeriodSec - the maximum amount of time to perform data retention in seconds
    
    Returns:
    
    the number of records deleted
  - getMaxAuditLogAgeDays
```
int getMaxAuditLogAgeDays()
```
    Return the age in days at which an audit log entry becomes eligible for purging.
    
    Returns:
    
    The age in days at which an audit log entry becomes eligible for purging
    
    Since:
    
    4.1.0
  - getMaxCollaborationJobAgeDays
```
int getMaxCollaborationJobAgeDays()
```
    Return the maximum age (in days) of collaboration jobs and all associated entities such as job steps, job actions and submissions.
    
    Returns:
    
    the maximum age (in days) of collaboration jobs
    
    Since:
    
    4.3.3
  - getMaxEmailQueueAgeDays
```
int getMaxEmailQueueAgeDays()
```
    Return the max email queue age days.
    
    Returns:
    
    the max email queue age days
    
    Since:
    
    4.1.0
  - getMaxErrorLogAgeDays
```
int getMaxErrorLogAgeDays()
```
    Return the age in days at which an error log entry becomes eligible for purging.
    
    Returns:
    
    the age in days at which an error log entry becomes eligible for purging
    
    Since:
    
    4.1.0
  - getMaxEventLogAgeDays
```
int getMaxEventLogAgeDays()
```
    Return the age in days at which an event log entry becomes eligible for purging.
    
    Returns:
    
    The age in days at which an event log entry becomes eligible for purging
    
    Since:
    
    4.1.0
  - getMaxGroovyServiceLogAgeDays
```
int getMaxGroovyServiceLogAgeDays()
```
    Return the age in days at which a groovy service log entry becomes eligible for purging.
    
    Returns:
    
    The age in days at which a groovy service log entry becomes eligible for purging
    
    Since:
    
    4.1.0
  - getMaxImportLogAgeDays
```
int getMaxImportLogAgeDays()
```
    Return the max import log age days.
    
    Returns:
    
    the max import log age days
    
    Since:
    
    4.1.0
  - getMaxOfflineSyncLogAgeDays
```
int getMaxOfflineSyncLogAgeDays()
```
    Return the age in days at which a Field Worker sync log entry becomes eligible for purging.
    
    Returns:
    
    the age in days at which a Field Worker sync log entry becomes eligible for purging
    
    Since:
    
    4.1.0
  - getMaxScheduledJobHistoryAgeDays
```
int getMaxScheduledJobHistoryAgeDays()
```
    Return the age in days at which a scheduled job history entry becomes eligible for purging.
    
    Returns:
    
    the age in days at which a scheduled job history entry becomes eligible for purging.
    
    Since:
    
    4.3.0
  - getMaxSecurityManagerLogAgeDays
```
int getMaxSecurityManagerLogAgeDays()
```
    Return the age in days at which a security manager log entry becomes eligible for purging.
    
    Returns:
    
    the age in days at which a security manager log entry becomes eligible for purging.
    
    Since:
    
    5.1.0
  - getMaxServerHealthLogAgeDays
```
int getMaxServerHealthLogAgeDays()
```
    Return the age in days at which a server health log entry becomes eligible for purging.
    
    Returns:
    
    the age in days at which a server health log entry becomes eligible for purging
    
    Since:
    
    4.1.0
  - getMaxSubmissionLogAgeDays
```
int getMaxSubmissionLogAgeDays()
```
    Return the max submission log age days.
    
    Returns:
    
    the max submission log age days
    
    Since:
    
    4.1.0
  - getMaxDeliveredSubmissionDataAgeDays
```
int getMaxDeliveredSubmissionDataAgeDays()
```
    Return the max delivered submission data age in days.
    
    Returns:
    
    the purge delivered submission days
    
    Since:
    
    4.1.0
  - getMaxSavedSubmissionAgeDays
```
int getMaxSavedSubmissionAgeDays()
```
    Return the max saved submission data age days.
    
    Returns:
    
    the max saved submission data age days
    
    Since:
    
    4.1.0
  - getMaxTransactionHistoryAgeDays
```
int getMaxTransactionHistoryAgeDays()
```
    Return the maximum age of the transaction history in days.
    
    Returns:
    
    the maxTransactionHistoryAgeDays
    
    Since:
    
    4.1.0
  - getMaxUserAuthEventAgeDays
```
int getMaxUserAuthEventAgeDays()
```
    Return the age in days at which a user authentication event becomes eligible for purging.
    
    Returns:
    
    The age in days at which a user authentication event becomes eligible for purging
    
    Since:
    
    4.1.3
  - isEnforceGlobalThreshold
```
boolean isEnforceGlobalThreshold()
```
    Return whether the service is configured to enforce global policies over organization and form level policies. If set, organizations and forms cannot specify retention times that are less restrictive (=longer) than the current global settings.
    
    Returns:
    
    whether the service is configured to enforce global policies
    
    Since:
    
    4.1.0
  - getPiiSearchPurgeMode
```
String getPiiSearchPurgeMode()
```
    Returns:
    
    the piiSearchPurgeMode String
    
    Since:
    
    18.11.0
  - setLogToEventLog
```
void setLogToEventLog(boolean value)
```
    Specify whether to log the results of the data retention job to the event log.
    
    Parameters:
    
    value - to specify whether to log the results of the data retention job to the event log
    
    Since:
    
    4.3.3

Interface IDataRetentionManagementService

Field Summary

Method Summary

Field Detail

PARAM_MAX_AUDIT_LOG_AGE_DAYS

PARAM_MAX_COLLABORATION_JOB_AGE_DAYS

PARAM_MAX_EMAIL_QUEUE_AGE_DAYS

PARAM_MAX_ERROR_LOG_AGE_DAYS

PARAM_MAX_EVENT_LOG_AGE_DAYS

PARAM_MAX_GROOVY_SERVICE_LOG_AGE_DAYS

PARAM_MAX_OFFLINE_SYNC_LOG_AGE_DAYS

PARAM_MAX_SCHEDULED_JOB_HISTORY_AGE_DAYS

PARAM_MAX_SECURITY_MANAGER_LOG_AGE_DAYS

PARAM_MAX_SUBMISSION_LOG_AGE_DAYS

PARAM_MAX_SAVED_SUBMISSION_AGE_DAYS

PARAM_MAX_TRANSACTION_HISTORY_AGE_DAYS

PARAM_MAX_DELIVERED_SUBMISSION_DATA_AGE_DAYS

PARAM_MAX_USER_AUTH_EVENT_AGE_DAYS

PARAM_ENFORCE_GLOBAL_THRESHOLD

PARAM_PII_SEARCH_PURGE_MODE

PII_SEARCH_PURGE_MODE_FORM_COMPLETED

PII_SEARCH_PURGE_MODE_DELIVERY_COMPLETED

PARAM_PII_SEARCH_PURGE_MODE_PURGE_TIME

Method Detail

applyDataRetentionPolicy

getMaxAuditLogAgeDays

getMaxCollaborationJobAgeDays

getMaxEmailQueueAgeDays

getMaxErrorLogAgeDays

getMaxEventLogAgeDays

getMaxGroovyServiceLogAgeDays

getMaxImportLogAgeDays

getMaxOfflineSyncLogAgeDays

getMaxScheduledJobHistoryAgeDays

getMaxSecurityManagerLogAgeDays

getMaxServerHealthLogAgeDays

getMaxSubmissionLogAgeDays

getMaxDeliveredSubmissionDataAgeDays

getMaxSavedSubmissionAgeDays

getMaxTransactionHistoryAgeDays

getMaxUserAuthEventAgeDays

isEnforceGlobalThreshold

getPiiSearchPurgeMode

setLogToEventLog