Package org.opencms.file.history
Class CmsHistoryFile
- java.lang.Object
-
- org.opencms.file.CmsResource
-
- org.opencms.file.CmsFile
-
- org.opencms.file.history.CmsHistoryFile
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
,java.lang.Comparable<I_CmsResource>
,I_CmsHistoryResource
,I_CmsResource
public class CmsHistoryFile extends CmsFile implements I_CmsHistoryResource
A historical version of a file in the OpenCms VFS resource history.- Since:
- 6.9.1
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.opencms.file.CmsResource
CmsResource.CmsResourceCopyMode, CmsResource.CmsResourceDeleteMode, CmsResource.CmsResourceUndoMode
-
Nested classes/interfaces inherited from interface org.opencms.file.I_CmsResource
I_CmsResource.CmsResourceAttribute
-
-
Field Summary
-
Fields inherited from class org.opencms.file.CmsResource
COPY_AS_NEW, COPY_AS_SIBLING, COPY_PRESERVE_SIBLING, DATE_EXPIRED_DEFAULT, DATE_RELEASED_DEFAULT, DATE_RELEASED_EXPIRED_IGNORE, DELETE_PRESERVE_SIBLINGS, DELETE_REMOVE_SIBLINGS, FLAG_INTERNAL, FLAG_LABELED, FLAG_TEMPFILE, m_dateContent, m_length, NAME_CONSTRAINTS, STATE_CHANGED, STATE_DELETED, STATE_KEEP, STATE_NEW, STATE_UNCHANGED, TEMP_FILE_PREFIX, TOUCH_DATE_UNCHANGED, UNDO_CONTENT, UNDO_CONTENT_RECURSIVE, UNDO_MOVE_CONTENT, UNDO_MOVE_CONTENT_RECURSIVE, VFS_FOLDER_SITES, VFS_FOLDER_SYSTEM
-
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
-
-
Constructor Summary
Constructors Constructor Description CmsHistoryFile(int publishTag, CmsUUID structureId, CmsUUID resourceId, java.lang.String path, int type, int flags, CmsUUID projectId, CmsResourceState state, long dateCreated, CmsUUID userCreated, long dateLastModified, CmsUUID userLastModified, long dateReleased, long dateExpired, int size, long dateContent, int version, CmsUUID parentId, byte[] content, int resourceVersion, int structureVersion)
Default Constructor.CmsHistoryFile(CmsResource resource)
Creates a dummy historical file from the given resource.CmsHistoryFile(I_CmsHistoryResource resource)
Constructor from a history resource.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
Returns a clone of this Objects instance.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.java.lang.String
getUserCreatedName(CmsObject cms)
Returns the name of the user that created this resource.java.lang.String
getUserLastModifiedName(CmsObject cms)
Returns the name of the user that last modified this resource.java.lang.String
toString()
-
Methods inherited from class org.opencms.file.CmsFile
getContents, getLength, isFile, isFolder, isTemporaryFile, setContents
-
Methods inherited from class org.opencms.file.CmsResource
checkResourceName, compareTo, equals, getCopy, getDateContent, getDateCreated, getDateExpired, getDateLastModified, getDateReleased, getExtension, getFlags, getFolderPath, getName, getName, getParentFolder, getPathLevel, getPathPart, getProjectLastModified, getResourceId, getRootPath, getSiblingCount, getState, getStructureId, getTypeId, getUserCreated, getUserLastModified, getVersion, hashCode, isExpired, isFolder, isInternal, isInternalOrInInternalFolder, isLabeled, isReleased, isReleasedAndNotExpired, isTemporaryFileName, isTouched, setDateExpired, setDateLastModified, setDateReleased, setFlags, setInternal, setState, setType, setUserLastModified
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.opencms.file.history.I_CmsHistoryResource
getVersion
-
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
-
-
-
-
Constructor Detail
-
CmsHistoryFile
public CmsHistoryFile(CmsResource resource)
Creates a dummy historical file from the given resource.- Parameters:
resource
- the resource to wrap
-
CmsHistoryFile
public CmsHistoryFile(I_CmsHistoryResource resource)
Constructor from a history resource.- Parameters:
resource
- the base history resource
-
CmsHistoryFile
public CmsHistoryFile(int publishTag, CmsUUID structureId, CmsUUID resourceId, java.lang.String path, int type, int flags, CmsUUID projectId, CmsResourceState state, long dateCreated, CmsUUID userCreated, long dateLastModified, CmsUUID userLastModified, long dateReleased, long dateExpired, int size, long dateContent, int version, CmsUUID parentId, byte[] content, int resourceVersion, int structureVersion)
Default Constructor.- Parameters:
publishTag
- the publish tag of this historical resourcestructureId
- the id of this resources structure recordresourceId
- the id of this resources resource recordpath
- the filename of this resoucetype
- the type of this resourceflags
- the flags of this resourceprojectId
- the project id this resource was last modified instate
- the state of this resourcedateCreated
- the creation date of this resourceuserCreated
- the id of the user who created this resourcedateLastModified
- the date of the last modification of this resourceuserLastModified
- the id of the user who did the last modification of this resourcedateReleased
- the release date of this resourcedateExpired
- the expiration date of this resourcesize
- the size of the file content of this resourcedateContent
- the date of the last modification of the content of this resourceversion
- the version number of this resourceparentId
- structure id of the parent of this historical resourcecontent
- the content of this versionresourceVersion
- the version number of the resource part for this historical resourcestructureVersion
- the version number of the structure part for this historical resource
-
-
Method Detail
-
clone
public java.lang.Object clone()
Returns a clone of this Objects instance.
-
getParentId
public CmsUUID getParentId()
Description copied from interface:I_CmsHistoryResource
Returns the structure id of the parent resource.- Specified by:
getParentId
in interfaceI_CmsHistoryResource
- Returns:
- the structure id of the parent resource
- See Also:
I_CmsHistoryResource.getParentId()
-
getPublishTag
public int getPublishTag()
Description copied from interface:I_CmsHistoryResource
Returns the publish tag of this historical resource.- Specified by:
getPublishTag
in interfaceI_CmsHistoryResource
- Returns:
- the publish tag of this historical resource
- See Also:
I_CmsHistoryResource.getPublishTag()
-
getUserCreatedName
public java.lang.String getUserCreatedName(CmsObject cms)
Returns the name of the user that created this resource.- Parameters:
cms
- the current cms context- Returns:
- the name of the user that created this resource
-
getUserLastModifiedName
public java.lang.String getUserLastModifiedName(CmsObject cms)
Returns the name of the user that last modified this resource.- Parameters:
cms
- the current cms context- Returns:
- the name of the user that last modified this resource
-
getResourceVersion
public int getResourceVersion()
Description copied from interface:I_CmsHistoryResource
Returns the version number of the resource part for this historical resource.- Specified by:
getResourceVersion
in interfaceI_CmsHistoryResource
- Returns:
- the version number of the resource part for this historical resource
- See Also:
I_CmsHistoryResource.getResourceVersion()
-
getStructureVersion
public int getStructureVersion()
Description copied from interface:I_CmsHistoryResource
Returns the version number of the structure part for this historical resource.- Specified by:
getStructureVersion
in interfaceI_CmsHistoryResource
- Returns:
- the version number of the structure part for this historical resource
- See Also:
I_CmsHistoryResource.getStructureVersion()
-
toString
public java.lang.String toString()
- Overrides:
toString
in classCmsResource
- See Also:
CmsResource.toString()
-
-