com.day.cq.wcm.api

Interface VersionManager.PurgeInfo

Enclosing interface:

VersionManager

public static interface VersionManager.PurgeInfo

General info about version purging.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getError() Returns an informative string of an error that occurred during purging, or null.
java.lang.String	getTitle() Returns the title of the versioned node if it is a page.
java.util.Calendar	getVersionCreated() Returns the creation date of the version
java.lang.String	getVersionedNodePath() Returns the node's path that this version belongs to.
java.lang.String[]	getVersionLabels() Returns the labels of the version
java.lang.String	getVersionName() Returns the name of the version
java.lang.String	getVersionPath() Returns the path of the version
boolean	isBaseVersion() Returns true if this is the current base version
boolean	isRetained() Returns true if the version was not purged

Method Detail

getVersionName

java.lang.String getVersionName()

Returns the name of the version

Returns:

the name of the version

getVersionPath

java.lang.String getVersionPath()

Returns the path of the version

Returns:

the path of the version

getVersionLabels

java.lang.String[] getVersionLabels()

Returns the labels of the version

Returns:

the labels of the version

getVersionCreated

java.util.Calendar getVersionCreated()

Returns the creation date of the version

Returns:

the creation date of the version

isRetained

boolean isRetained()

Returns true if the version was not purged

Returns:

true if the version was not purged

isBaseVersion

boolean isBaseVersion()

Returns true if this is the current base version

Returns:

true if this is the current base version

getError

java.lang.String getError()

Returns an informative string of an error that occurred during purging, or null.

Returns:

the error string or null.

getTitle

java.lang.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

java.lang.String getVersionedNodePath()

Returns the node's path that this version belongs to.

Returns:

The versioned node's path