org.opencms.file.history

Interface I_CmsHistoryResource

All Superinterfaces:

java.lang.Cloneable, java.lang.Comparable<I_CmsResource>, I_CmsResource, java.io.Serializable

All Known Implementing Classes:

CmsHistoryFile, CmsHistoryFolder

public interface I_CmsHistoryResource
extends I_CmsResource, java.lang.Cloneable, java.io.Serializable, java.lang.Comparable<I_CmsResource>

A historical version of a resource in the OpenCms VFS resource history.

History resources are resources that contain additional information used to describe the historical state.

The historical resource object extends the resource object since it be an history for a file as well as for a folder.

History resources contain the names of the users that created or last modified the resource as string obejcts because a user id might have been deleted.

Since:

6.9.1

Nested Class Summary

Nested classes/interfaces inherited from interface org.opencms.file.I_CmsResource

I_CmsResource.CmsResourceAttribute

Field Summary

Fields inherited from interface org.opencms.file.I_CmsResource

COMPARE_DATE_LAST_MODIFIED, COMPARE_DATE_RELEASED, COMPARE_ROOT_PATH, COMPARE_ROOT_PATH_IGNORE_CASE, COMPARE_ROOT_PATH_IGNORE_CASE_FOLDERS_FIRST

Method Summary

Modifier and Type	Method and Description
CmsUUID	getParentId() Returns the structure id of the parent resource.
int	getPublishTag() Returns the publish tag of this historical resource.
int	getResourceVersion() Returns the version number of the resource part for this historical resource.
int	getStructureVersion() Returns the version number of the structure part for this historical resource.
int	getVersion() Returns the version number of this historical resource.

Methods inherited from interface org.opencms.file.I_CmsResource

getDateContent, getDateCreated, getDateExpired, getDateLastModified, getDateReleased, getFlags, getLength, getName, getProjectLastModified, getResourceId, getRootPath, getSiblingCount, getState, getStructureId, getTypeId, getUserCreated, getUserLastModified, isExpired, isFile, isFolder, isInternal, isLabeled, isReleased, isReleasedAndNotExpired, isTouched

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getParentId

CmsUUID getParentId()

Returns the structure id of the parent resource.

Returns:

the structure id of the parent resource

getPublishTag

int getPublishTag()

Returns the publish tag of this historical resource.

Returns:

the publish tag of this historical resource

getResourceVersion

int getResourceVersion()

Returns the version number of the resource part for this historical resource.

Returns:

the version number of the resource part for this historical resource

getStructureVersion

int getStructureVersion()

Returns the version number of the structure part for this historical resource.

Returns:

the version number of the structure part for this historical resource

getVersion

int getVersion()

Returns the version number of this historical resource.

Specified by:

getVersion in interface I_CmsResource

Returns:

the version number of this historical resource