PurgeObjectsTask

java.lang.Object
- sailpoint.task.AbstractTaskExecutor
- - com.identityworksllc.iiq.common.task.PurgeObjectsTask

All Implemented Interfaces:

sailpoint.object.BaseExecutor, sailpoint.object.TaskExecutor
```
public class PurgeObjectsTask
extends sailpoint.task.AbstractTaskExecutor
```
PurgeObjectsTask is a SailPoint IIQ task executor that deletes objects of a specified type from the database.
Features
- Deletes all objects of a given type, or only those matching a filter.
- Supports in-memory filtering using HybridObjectMatcher.
- Can run in simulation mode to log objects that would be deleted without actually deleting them.
- Tracks progress and supports early termination.
Attributes
- objectType (String): The SailPoint object type to purge (required).
- deleteAll (Boolean): If true, deletes all objects of the type. If false, uses a filter (default: false).
- filter (String): A SailPoint filter string to select objects to delete (required if deleteAll is false).
- inMemoryFilter (Boolean): If true, applies the filter in memory (default: false).
- simulate (Boolean): If true, only logs objects that would be deleted (default: true).

Field Summary
- Fields inherited from class sailpoint.task.AbstractTaskExecutor
  ARG_FILTER, ARG_LOCK_MODE, ARG_LOCK_TIMEOUT, ARG_PROFILE, ARG_RESTARTABLE, ARG_TRACE, DEFAULT_LOCK_TIMEOUT, RET_TOTAL

Constructor Summary

Constructors
Constructor Description

PurgeObjectsTask()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`execute(sailpoint.api.SailPointContext context, sailpoint.object.TaskSchedule taskSchedule, sailpoint.object.TaskResult taskResult, sailpoint.object.Attributes<String,Object> attributes)`	Executes the purge task, deleting or simulating deletion of objects.
`boolean`	`terminate()`	Terminates the purge task early.

Methods inherited from class sailpoint.task.AbstractTaskExecutor
getMonitor, getSuggestedPartitionCount, getSuggestedPartitionCount, launchPartitions, processCommand, saveRequest, setMonitor, updateProgress, updateProgress

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PurgeObjectsTask
```
public PurgeObjectsTask()
```
- Method Detail
  - execute
```
public void execute(sailpoint.api.SailPointContext context,
                    sailpoint.object.TaskSchedule taskSchedule,
                    sailpoint.object.TaskResult taskResult,
                    sailpoint.object.Attributes<String,Object> attributes)
             throws Exception
```
    Executes the purge task, deleting or simulating deletion of objects.
    
    Parameters:
    
    context - SailPointContext for database operations
    
    taskSchedule - The schedule for this task
    
    taskResult - The result object to record progress and output
    
    attributes - Task attributes (see class-level docs)
    
    Throws:
    
    Exception - if required attributes are missing or errors occur
  - terminate
```
public boolean terminate()
```
    Terminates the purge task early.
    
    Returns:
    
    true if termination was successful