| Class | com.enterworks.client.facade.workitem.WorkItemFacade |
|---|---|
| Parameters | SessionProfile profile — the session profile object for the current logged-in session. String workItemName — the name of the work item to be purged; wildcards are allowed, and a null or empty value means the * wildcard (i.e., all work item names) Collection (ArrayList) processIdList — a list of processes (the ProcessId Integer value from each ProcessVo) to purge work items for; a zero-length list implies that work items should be deleted from all process flows. boolean deleteOnlyCompletedWorkItems — true if delete only completed work items; false if delete all; defaults to a value of false. java.util.Date modifiedDateRangeStart — the start date for purging work items; only work items modified on or between modifiedDateRangeStart and modifiedDateRangeEnd should be deleted; a value of null means that there is no minimum modified date. java.util.Date modifiedDateRangeEnd — the end date for purging work items only work items modified on or between modifiedDateRangeStart and modifiedDateRangeEnd should be deleted; a value of null means that there is no minimum modified date. boolean isPreviewOnly — true if preview; false if purge; boolean value indicating that the operation is only a preview and will not actually delete any work items; instead, it will return the number of work items that would be deleted if the specified criteria was used. |
| Description | This method deletes the work items that match the criteria specified by the parameters; it returns the number of work items deleted as an integer value. The purging user must have Delete permissions on each Process Flow whose work items are to be purged. |