Uses of Interface
org.opencms.file.history.I_CmsHistoryResource

Packages that use I_CmsHistoryResource

Package	Description
org.opencms.db	Low-level database connection and access functionality.
org.opencms.db.generic	Generic (ANSI-SQL) implementation of the OpenCms database connector.
org.opencms.file	This important package provides the methods to access the OpenCms VFS repository with the permissions of an authenticated user.
org.opencms.file.history	This package contains the classes to deal with the OpenCms VFS history archive.

Uses of I_CmsHistoryResource in org.opencms.db

Methods in org.opencms.db that return I_CmsHistoryResource

Modifier and Type	Method	Description
I_CmsHistoryResource	CmsDriverManager.readResource(CmsDbContext dbc, CmsResource resource, int version)	Reads an historical resource entry for the given resource and with the given version number.
I_CmsHistoryResource	CmsSecurityManager.readResource(CmsRequestContext context, CmsResource resource, int version)	Reads the historical resource entry for the given resource with the given version number.
I_CmsHistoryResource	I_CmsHistoryDriver.readResource(CmsDbContext dbc, CmsUUID structureId, int version)	Reads a historical resource version without including the file content.

Methods in org.opencms.db that return types with arguments of type I_CmsHistoryResource

Modifier and Type	Method	Description
java.util.List<I_CmsHistoryResource>	I_CmsHistoryDriver.getAllDeletedEntries(CmsDbContext dbc)	Returns all historical resources (of deleted resources).
java.util.List<I_CmsHistoryResource>	I_CmsHistoryDriver.getAllNotDeletedEntries(CmsDbContext dbc)	Returns all historical resources (of not deleted resources).
java.util.List<I_CmsHistoryResource>	CmsDriverManager.readAllAvailableVersions(CmsDbContext dbc, CmsResource resource)	Reads all versions of the given resource. This method returns a list with the history of the given resource, i.e.
java.util.List<I_CmsHistoryResource>	CmsSecurityManager.readAllAvailableVersions(CmsRequestContext context, CmsResource resource)	Reads all historical versions of a resource.
java.util.List<I_CmsHistoryResource>	I_CmsHistoryDriver.readAllAvailableVersions(CmsDbContext dbc, CmsUUID structureId)	Reads all file headers of the resource with the given structure id.
java.util.List<I_CmsHistoryResource>	CmsDriverManager.readDeletedResources(CmsDbContext dbc, CmsResource resource, boolean readTree, boolean isVfsManager)	Reads all deleted (historical) resources below the given path, including the full tree below the path, if required.
java.util.List<I_CmsHistoryResource>	CmsSecurityManager.readDeletedResources(CmsRequestContext context, CmsResource resource, boolean readTree)	Reads all deleted (historical) resources below the given path, including the full tree below the path, if required.
java.util.List<I_CmsHistoryResource>	I_CmsHistoryDriver.readDeletedResources(CmsDbContext dbc, CmsUUID structureId, CmsUUID userId)	Reads all deleted (historical) resources below the given path, that the given user deleted by itself.
java.util.List<I_CmsHistoryResource>	CmsDriverManager.readSubscribedDeletedResources(CmsDbContext dbc, java.lang.String poolName, CmsUser user, java.util.List<CmsGroup> groups, CmsResource parent, boolean includeSubFolders, long deletedFrom)	Returns the subscribed history resources that were deleted.
java.util.List<I_CmsHistoryResource>	CmsSecurityManager.readSubscribedDeletedResources(CmsRequestContext context, java.lang.String poolName, CmsUser user, java.util.List<CmsGroup> groups, CmsResource parent, boolean includeSubFolders, long deletedFrom)	Returns the subscribed history resources that were deleted.
java.util.List<I_CmsHistoryResource>	CmsSubscriptionManager.readSubscribedDeletedResources(CmsObject cms, CmsUser user, boolean includeGroups, java.lang.String folderPath, boolean includeSubFolders, long deletedFrom)	Returns the subscribed history resources that were deleted.
java.util.List<I_CmsHistoryResource>	I_CmsSubscriptionDriver.readSubscribedDeletedResources(CmsDbContext dbc, java.lang.String poolName, CmsUser user, java.util.List<CmsGroup> groups, CmsResource parent, boolean includeSubFolders, long deletedFrom)	Returns the subscribed history resources that were deleted.

Methods in org.opencms.db with parameters of type I_CmsHistoryResource

Modifier and Type	Method	Description
int	I_CmsHistoryDriver.deleteEntries(CmsDbContext dbc, I_CmsHistoryResource histResource, int versionsToKeep, long time)	Deletes all historical versions of a resource keeping maximal versionsToKeep versions.
java.util.List<CmsProperty>	CmsDriverManager.readHistoryPropertyObjects(CmsDbContext dbc, I_CmsHistoryResource historyResource)	Reads the list of all CmsProperty objects that belongs to the given historical resource.
java.util.List<CmsProperty>	CmsSecurityManager.readHistoryPropertyObjects(CmsRequestContext context, I_CmsHistoryResource resource)	Reads the list of all CmsProperty objects that belong to the given historical resource.
java.util.List<CmsProperty>	I_CmsHistoryDriver.readProperties(CmsDbContext dbc, I_CmsHistoryResource historicalResource)	Returns a list of all properties of a historical file or folder.

Uses of I_CmsHistoryResource in org.opencms.db.generic

Methods in org.opencms.db.generic that return I_CmsHistoryResource

Modifier and Type	Method	Description
protected I_CmsHistoryResource	CmsHistoryDriver.internalCreateResource(java.sql.ResultSet res)	Creates a valid I_CmsHistoryResource instance from a JDBC ResultSet.
protected I_CmsHistoryResource	CmsHistoryDriver.internalMergeResource(I_CmsHistoryResource histRes, java.sql.ResultSet res, int versionOffset)	Merges an historical entry for a sibling, based on the structure data from the given historical resource and result set for the resource entry.
I_CmsHistoryResource	CmsHistoryDriver.readResource(CmsDbContext dbc, CmsUUID structureId, int version)

Methods in org.opencms.db.generic that return types with arguments of type I_CmsHistoryResource

Modifier and Type	Method	Description
java.util.List<I_CmsHistoryResource>	CmsHistoryDriver.getAllDeletedEntries(CmsDbContext dbc)
java.util.List<I_CmsHistoryResource>	CmsHistoryDriver.getAllNotDeletedEntries(CmsDbContext dbc)
java.util.List<I_CmsHistoryResource>	CmsHistoryDriver.readAllAvailableVersions(CmsDbContext dbc, CmsUUID structureId)
java.util.List<I_CmsHistoryResource>	CmsHistoryDriver.readDeletedResources(CmsDbContext dbc, CmsUUID structureId, CmsUUID userId)
java.util.List<I_CmsHistoryResource>	CmsSubscriptionDriver.readSubscribedDeletedResources(CmsDbContext dbc, java.lang.String poolName, CmsUser user, java.util.List<CmsGroup> groups, CmsResource parent, boolean includeSubFolders, long deletedFrom)

Methods in org.opencms.db.generic with parameters of type I_CmsHistoryResource

Modifier and Type	Method	Description
int	CmsHistoryDriver.deleteEntries(CmsDbContext dbc, I_CmsHistoryResource resource, int versionsToKeep, long time)
protected void	CmsHistoryDriver.internalAddToPropMap(java.util.Map<java.lang.String,CmsProperty> propertyMap, I_CmsHistoryResource resource, java.lang.String propertyKey, java.lang.String propertyValue, int mappingType)	Updates the property map for the given resource with the given property data.
protected void	CmsHistoryDriver.internalCleanup(CmsDbContext dbc, I_CmsHistoryResource resource)	Deletes all historical entries of subresources of a folder without any historical netry left.
protected I_CmsHistoryResource	CmsHistoryDriver.internalMergeResource(I_CmsHistoryResource histRes, java.sql.ResultSet res, int versionOffset)	Merges an historical entry for a sibling, based on the structure data from the given historical resource and result set for the resource entry.
java.util.List<CmsProperty>	CmsHistoryDriver.readProperties(CmsDbContext dbc, I_CmsHistoryResource resource)

Uses of I_CmsHistoryResource in org.opencms.file

Methods in org.opencms.file that return I_CmsHistoryResource

Modifier and Type	Method	Description
I_CmsHistoryResource	CmsObject.readResource(CmsUUID structureID, int version)	Reads the historical resource with the given version for the resource given the given structure id.

Methods in org.opencms.file that return types with arguments of type I_CmsHistoryResource

Modifier and Type	Method	Description
java.util.List<I_CmsHistoryResource>	CmsObject.readAllAvailableVersions(java.lang.String resourceName)	Reads all historical versions of a resource. The reading excludes the file content, if the resource is a file.
java.util.List<I_CmsHistoryResource>	CmsObject.readAllAvailableVersions(CmsResource resource)	Reads all available versions for a given resource.
java.util.List<I_CmsHistoryResource>	CmsObject.readDeletedResources(java.lang.String resourcename, boolean readTree)	Reads all deleted (historical) resources below the given path, including the full tree below the path, if required.

Methods in org.opencms.file with parameters of type I_CmsHistoryResource

Modifier and Type	Method	Description
java.util.List<CmsProperty>	CmsObject.readHistoryPropertyObjects(I_CmsHistoryResource resource)	Reads the list of all CmsProperty objects that belong to the given historical resource version.

Uses of I_CmsHistoryResource in org.opencms.file.history

Classes in org.opencms.file.history that implement I_CmsHistoryResource

Modifier and Type	Class	Description
class	CmsHistoryFile	A historical version of a file in the OpenCms VFS resource history.
class	CmsHistoryFolder	A historical version of a file in the OpenCms VFS resource history.

Methods in org.opencms.file.history that return I_CmsHistoryResource

Modifier and Type	Method	Description
static I_CmsHistoryResource	CmsHistoryResourceHandler.getHistoryResource(javax.servlet.ServletRequest req)	Returns the historical version of a resource, if the given request is displaying a history version.

Constructors in org.opencms.file.history with parameters of type I_CmsHistoryResource

Constructor	Description
CmsHistoryFile(I_CmsHistoryResource resource)	Constructor from a history resource.
CmsHistoryFolder(I_CmsHistoryResource resource)	Constructor from a history resource.