# Class: PurgeOptions

## tibco.objectapi.ec.base.PurgeOptions

#### new PurgeOptions()

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

The following features are supported:

- `Batch Size`
- `Run In Background`
- `Threshold`
- `Advanced Option`
- `Process Templates`
- `Required Extended Data`

### Members

#### advancedOption :Array.<tibco.objectapi.ec.base.AdvancedPurgeOption>

This property holds the value of the 'Advanced Option' containment reference list.

##### Type:

- Array.<tibco.objectapi.ec.base.AdvancedPurgeOption>

#### 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

#### processTemplates :tibco.objectapi.ec.base.ProcessTemplates

This property holds the value of the 'Process Templates' containment reference.

##### Type:

- tibco.objectapi.ec.base.ProcessTemplates

#### requiredExtendedData :tibco.objectapi.ec.base.RequiredExtendedDataOptions

This property holds the value of the 'Required Extended Data' containment reference.

##### Type:

- tibco.objectapi.ec.base.RequiredExtendedDataOptions

#### 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

#### 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