CmsPublishHistoryCleanupFilter (OpenCms Core API, version 17.0)

java.lang.Object
- org.opencms.db.generic.CmsPublishHistoryCleanupFilter

```
public class CmsPublishHistoryCleanupFilter
extends java.lang.Object
```
Filter object that describes what to clean up in a publish history cleanup operation.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class CmsPublishHistoryCleanupFilter.Mode
Mode of operation for publish history cleanup.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static CmsPublishHistoryCleanupFilter`	`allUnreferencedExcept(java.util.List<CmsUUID> exceptions)`	Creates a new filter for removing all unreferenced publish history entries, except the ones with the given history ids.
`static CmsPublishHistoryCleanupFilter`	`forHistoryId(CmsUUID publishJobId)`	Creates a filter for removing the publish history entries for a single history id.
`java.util.List<CmsUUID>`	`getExceptions()`	Gets the list of history ids for which entries should not be deleted.
`CmsUUID`	`getHistoryId()`	Gets the history id.
`CmsPublishHistoryCleanupFilter.Mode`	`getMode()`	Gets the mode.

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

- Method Detail
  - allUnreferencedExcept
```
public static CmsPublishHistoryCleanupFilter allUnreferencedExcept(java.util.List<CmsUUID> exceptions)
```
    Creates a new filter for removing all unreferenced publish history entries, except the ones with the given history ids.
    
    Parameters:
    
    exceptions - the history ids for which entries should not be deleted
    
    Returns:
    
    the filter
  - forHistoryId
```
public static CmsPublishHistoryCleanupFilter forHistoryId(CmsUUID publishJobId)
```
    Creates a filter for removing the publish history entries for a single history id.
    
    Parameters:
    
    publishJobId - the history id
    
    Returns:
    
    the filter
  - getExceptions
```
public java.util.List<CmsUUID> getExceptions()
```
    Gets the list of history ids for which entries should not be deleted.
    
    Returns:
    
    the list of history ids for which entries should not be deleted
  - getHistoryId
```
public CmsUUID getHistoryId()
```
    Gets the history id.
    
    Returns:
    
    the history id
  - getMode
```
public CmsPublishHistoryCleanupFilter.Mode getMode()
```
    Gets the mode.
    
    Returns:
    
    the mode