# Class: PurgeOptions

## tibco.objectapi.pm.PurgeOptions

#### new PurgeOptions()

Provides options to control how a purge is carried out. Constructs a new PurgeOptions.

The following features are supported:

- `States`
- `Batch Size`
- `Run In Background`
- `Threshold`
- `Applications`
- `Process Templates`
- `Process Instances`

### Members

#### applications :tibco.objectapi.pm.Applications

(Optional) specified the applications for which all the process instances in the contained process templates are to be purged. This property holds the value of the 'Applications' containment reference.

##### Type:

- tibco.objectapi.pm.Applications

#### batchSize :number

(Optional) Number of process instances that should be deleted before the transaction is committed. Default value: 100 This property holds the value of the 'Batch Size' attribute.

##### Type:

- number

#### processInstances :tibco.objectapi.pm.ProcessInstancesType

(Optional) specified the tagged process instances to be purged. This property holds the value of the 'Process Instances' containment reference.

##### Type:

- tibco.objectapi.pm.ProcessInstancesType

#### processTemplates :tibco.objectapi.pm.ProcessTemplatesType

(Optional) specified the tagged process templates for which the corresponding instances are to be purged. This property holds the value of the 'Process Templates' containment reference.

##### Type:

- tibco.objectapi.pm.ProcessTemplatesType

#### runInBackground :boolean

(Optional) Boolean value specifying whether the purge runs in the background. If: - True: The purge will run in the background and the operation returns immediately. This is the default value. - False: The operation waits for the purge to complete before returning (subject to timeouts). This property holds the value of the 'Run In Background' attribute.

##### Type:

- boolean

#### states :tibco.objectapi.pm.TerminalStates

(Optional) purge those process instances with specified state(s). If no state(s) are specified, then process instances that are in a terminal state will be purged. This property holds the value of the 'States' containment reference.

##### Type:

- tibco.objectapi.pm.TerminalStates

#### threshold :Date

(Optional) Date before which process instances must have been completed, cancelled or failed for them to be purged in this operation. If this value is omitted, all completed, cancelled and failed instances will be deleted. This property holds the value of the 'Threshold' attribute.

##### Type:

- Date