com.day.cq.wcm.api

Interface VersionManager

public interface VersionManager

VersionManager provides methods to manage page versions.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	VersionManager.PurgeInfo General info about version purging.

Method Summary

Modifier and Type	Method and Description
java.util.List<VersionManager.PurgeInfo>	purgeVersions(Node node, boolean dryRun) Returns a list of purge infos of the versions that are purged using the configured conditions.
java.util.List<VersionManager.PurgeInfo>	purgeVersions(Node node, boolean dryRun, int maxVersions, int maxAge) Returns a list of purge infos of the versions that are purged using the specified conditions.
java.util.List<VersionManager.PurgeInfo>	purgeVersions(Session session, java.lang.String path, boolean dryRun, boolean recursive) Returns a list of purge infos of the versions that are purged using the configured conditions.
java.util.List<VersionManager.PurgeInfo>	purgeVersions(Session session, java.lang.String path, boolean dryRun, boolean recursive, int maxVersions, int maxAge) Returns a list of purge infos of the versions that are purged using the specified conditions.
java.util.List<VersionManager.PurgeInfo>	purgeVersions(Session session, java.lang.String path, boolean dryRun, boolean recursive, int maxVersions, int maxAge, int minVersions) Returns a list of purge infos of the versions that are purged using the specified conditions.

Method Detail

purgeVersions

java.util.List<VersionManager.PurgeInfo> purgeVersions(Node node,
                                                       boolean dryRun)

Returns a list of purge infos of the versions that are purged using the configured conditions.

Parameters:

node - of which the versions are to be purged

dryRun - if true the versions are not removed

Returns:

list of versions to purge

purgeVersions

java.util.List<VersionManager.PurgeInfo> purgeVersions(Node node,
                                                       boolean dryRun,
                                                       int maxVersions,
                                                       int maxAge)

Returns a list of purge infos of the versions that are purged using the specified conditions.

Parameters:

node - of which the versions are to be purged

dryRun - if true the versions are not removed

maxVersions - max number of versions to retain

maxAge - max age (in days) of versions to retain

Returns:

list of versions to purge

purgeVersions

java.util.List<VersionManager.PurgeInfo> purgeVersions(Session session,
                                                       java.lang.String path,
                                                       boolean dryRun,
                                                       boolean recursive)

Returns a list of purge infos of the versions that are purged using the configured conditions.

Parameters:

path - of which the versions are to be purged

session - to use for repository operations

dryRun - if true the versions are not removed

recursive - if versions for paths below given path should be purged

Returns:

list of versions to purge

purgeVersions

java.util.List<VersionManager.PurgeInfo> purgeVersions(Session session,
                                                       java.lang.String path,
                                                       boolean dryRun,
                                                       boolean recursive,
                                                       int maxVersions,
                                                       int maxAge)

Returns a list of purge infos of the versions that are purged using the specified conditions.

Parameters:

path - of which the versions are to be purged

session - to use for repository operations

dryRun - if true the versions are not removed

recursive - if versions for paths below given path should be purged

maxVersions - max number of versions to retain

maxAge - max age (in days) of versions to retain

Returns:

list of versions to purge

purgeVersions

java.util.List<VersionManager.PurgeInfo> purgeVersions(Session session,
                                                       java.lang.String path,
                                                       boolean dryRun,
                                                       boolean recursive,
                                                       int maxVersions,
                                                       int maxAge,
                                                       int minVersions)

Returns a list of purge infos of the versions that are purged using the specified conditions.

Parameters:

path - of which the versions are to be purged

session - to use for repository operations

dryRun - if true the versions are not removed

recursive - if versions for paths below given path should be purged

maxVersions - max number of versions to retain

maxAge - max age (in days) of versions to retain

minVersions - min number of versions to retain if possible

Returns:

list of versions to purge