|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface I_CmsHistoryResource
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.
Method Summary | |
---|---|
CmsUUID |
getBackupId()
Deprecated. this field has been removed |
java.lang.String |
getCreatedByName()
Deprecated. use {#getUserCreated()} instead now the CmsObject.readUser(CmsUUID)
also returns historical users |
long |
getDateContent()
Returns the date of the last modification of the content of this resource. |
long |
getDateCreated()
Returns the date of the creation of this resource. |
long |
getDateExpired()
Returns the expiration date this resource. |
long |
getDateLastModified()
Returns the date of the last modification of this resource. |
long |
getDateReleased()
Returns the release date this resource. |
int |
getFlags()
Returns the flags of this resource. |
java.lang.String |
getLastModifiedByName()
Deprecated. use {#getUserLastModified()} instead with CmsPrincipal.readPrincipalIncludingHistory(org.opencms.file.CmsObject, CmsUUID) |
int |
getLength()
Returns the length of the resource. |
java.lang.String |
getName()
Returns the name of this resource, e.g. |
CmsUUID |
getParentId()
Returns the structure id of the parent resource. |
CmsUUID |
getProjectLastModified()
Returns the id of the project where the resource has been last modified. |
int |
getPublishTag()
Returns the publish tag of this historical resource. |
int |
getPublishTagId()
Deprecated. use getPublishTag() instead |
CmsUUID |
getResourceId()
Returns the id of the resource database entry of this resource. |
int |
getResourceVersion()
Returns the version number of the resource part for this historical resource. |
java.lang.String |
getRootPath()
Returns the name of a resource with it's full path from the root folder including the current site root, for example /sites/default/myfolder/index.html . |
int |
getSiblingCount()
Returns the number of siblings of the resource, also counting this resource. |
CmsResourceState |
getState()
Returns the state of this resource. |
CmsUUID |
getStructureId()
Returns the id of the structure record of this resource. |
int |
getStructureVersion()
Returns the version number of the structure part for this historical resource. |
int |
getTypeId()
Returns the resource type id for this resource. |
CmsUUID |
getUserCreated()
Returns the user id of the user who created this resource. |
CmsUUID |
getUserLastModified()
Returns the user id of the user who made the last change on this resource. |
int |
getVersion()
Returns the version number of this historical resource. |
boolean |
isExpired(long time)
Returns true if this resource is expired at the given time according to the
information stored in getDateExpired() . |
boolean |
isFile()
Returns true if the resource is a file, i.e. can have no sub-resources. |
boolean |
isFolder()
Returns true if the resource is a folder, i.e. can have sub-resources. |
boolean |
isInternal()
Checks if the resource is internal. |
boolean |
isLabeled()
Checks if the link has to be labeled with a special icon in the explorer view. |
boolean |
isReleased(long time)
Returns true if this resource is released at the given time according to the
information stored in getDateReleased() . |
boolean |
isReleasedAndNotExpired(long time)
Returns true if this resource is valid at the given time according to the
information stored in getDateReleased() and getDateExpired() . |
boolean |
isTouched()
Returns true if this resource was touched. |
Methods inherited from interface java.lang.Comparable |
---|
compareTo |
Method Detail |
---|
CmsUUID getBackupId()
java.lang.String getCreatedByName()
CmsObject.readUser(CmsUUID)
also returns historical users
long getDateContent()
long getDateCreated()
long getDateExpired()
long getDateLastModified()
long getDateReleased()
int getFlags()
java.lang.String getLastModifiedByName()
CmsPrincipal.readPrincipalIncludingHistory(org.opencms.file.CmsObject, CmsUUID)
int getLength()
If the resource is a file, then this is the byte size of the file content. If the resource is a folder, then the size is always -1.
java.lang.String getName()
index.html
.
CmsUUID getParentId()
CmsUUID getProjectLastModified()
null
int getPublishTag()
int getPublishTagId()
getPublishTag()
instead
CmsUUID getResourceId()
int getResourceVersion()
java.lang.String getRootPath()
/sites/default/myfolder/index.html
.
int getSiblingCount()
If a resource has no sibling, the total sibling count for this resource is 1
,
if a resource has n
siblings, the sibling count is n + 1
.
CmsResourceState getState()
CmsUUID getStructureId()
int getStructureVersion()
int getTypeId()
CmsUUID getUserCreated()
CmsUUID getUserLastModified()
int getVersion()
boolean isExpired(long time)
true
if this resource is expired at the given time according to the
information stored in getDateExpired()
.
time
- the time to check the expiration date against
true
if this resource is expired at the given timeisReleased(long)
,
isReleasedAndNotExpired(long)
boolean isFile()
true
if the resource is a file, i.e. can have no sub-resources.
boolean isFolder()
true
if the resource is a folder, i.e. can have sub-resources.
boolean isInternal()
This state is stored as bit 1 in the resource flags.
boolean isLabeled()
This state is stored as bit 2 in the resource flags.
boolean isReleased(long time)
true
if this resource is released at the given time according to the
information stored in getDateReleased()
.
time
- the time to check the release date against
true
if this resource is released at the given timeisExpired(long)
,
isReleasedAndNotExpired(long)
boolean isReleasedAndNotExpired(long time)
true
if this resource is valid at the given time according to the
information stored in getDateReleased()
and getDateExpired()
.A resource is valid if it is released and not yet expired.
time
- the time to check the release and expiration date against
true
if this resource is valid at the given timeisExpired(long)
,
isReleased(long)
boolean isTouched()
|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |