Package com.day.cq.wcm.api
Interface VersionManager.PurgeInfo
-
- Enclosing interface:
- VersionManager
public static interface VersionManager.PurgeInfo
General info about version purging.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getError()
Returns an informative string of an error that occurred during purging, ornull
.String
getTitle()
Returns the title of the versioned node if it is a page.Calendar
getVersionCreated()
Returns the creation date of the versionString
getVersionedNodePath()
Returns the node's path that this version belongs to.String[]
getVersionLabels()
Returns the labels of the versionString
getVersionName()
Returns the name of the versionString
getVersionPath()
Returns the path of the versionboolean
isBaseVersion()
Returnstrue
if this is the current base versionboolean
isRetained()
Returnstrue
if the version was not purged
-
-
-
Method Detail
-
getVersionName
String getVersionName()
Returns the name of the version- Returns:
- the name of the version
-
getVersionPath
String getVersionPath()
Returns the path of the version- Returns:
- the path of the version
-
getVersionLabels
String[] getVersionLabels()
Returns the labels of the version- Returns:
- the labels of the version
-
getVersionCreated
Calendar getVersionCreated()
Returns the creation date of the version- Returns:
- the creation date of the version
-
isRetained
boolean isRetained()
Returnstrue
if the version was not purged- Returns:
true
if the version was not purged
-
isBaseVersion
boolean isBaseVersion()
Returnstrue
if this is the current base version- Returns:
true
if this is the current base version
-
getError
String getError()
Returns an informative string of an error that occurred during purging, ornull
.- Returns:
- the error string or null.
-
getTitle
String getTitle()
Returns the title of the versioned node if it is a page. Otherwise it returns the node name.- Returns:
- The page's title or node's name
-
getVersionedNodePath
String getVersionedNodePath()
Returns the node's path that this version belongs to.- Returns:
- The versioned node's path
-
-