Package org.opencms.db.generic

Class CmsPublishHistoryCleanupFilter

java.lang.Object

org.opencms.db.generic.CmsPublishHistoryCleanupFilter

public class CmsPublishHistoryCleanupFilter
extends 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 enum	CmsPublishHistoryCleanupFilter.Mode	Mode of operation for publish history cleanup.

Method Summary

Modifier and Type	Method	Description
static CmsPublishHistoryCleanupFilter	allUnreferencedExcept(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.
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 Details

allUnreferencedExcept

public static CmsPublishHistoryCleanupFilter allUnreferencedExcept(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 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