Retrieve Scheduled Purge Task Status

Checks to see whether domain-level cleanup is scheduled for the specified purge task type.

Syntax

Boolean isScheduledPurgeTaskEnable(SCHEDULE_PURGE_TASK task) throws SUPAdminException;

Returns

If successful, returns true or false. If unsuccessful, returns SUPAdminException.

Examples

Purge task status – retrieves the scheduled data purge task status for synchronization cache, subscription, client log, and error history purge tasks.

supDomain.isScheduledPurgeTaskEnable(SCHEDULE_PURGE_TASK.CLIENT_LOG);
supDomain.isScheduledPurgeTaskEnable(SCHEDULE_PURGE_TASK.ERROR_HISTORY);
supDomain.isScheduledPurgeTaskEnable(SCHEDULE_PURGE_TASK.SUBSCRIPTION);
supDomain.isScheduledPurgeTaskEnable(SCHEDULE_PURGE_TASK.SYNC_CACHE_GROUP);