I_CmsResource (OpenCms Core API, version 10.0.1)

All Known Subinterfaces:

I_CmsHistoryResource

All Known Implementing Classes:

CmsFile, CmsFolder, CmsHistoryFile, CmsHistoryFolder, CmsResource, CmsSearchResource
```
public interface I_CmsResource
```
Common ancestor interface for CmsFile and CmsFolder as well as for and CmsHistoryFolder.

Since:

8.0.0

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class I_CmsResource.CmsResourceAttribute
Enumeration for all attributes of a resource.

Nested Classes
Modifier and Type	Interface and Description
`static class`	`I_CmsResource.CmsResourceAttribute` Enumeration for all attributes of a resource.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.util.Comparator<I_CmsResource>`	`COMPARE_DATE_LAST_MODIFIED` A comparator for the date last modified of two resources.
`static java.util.Comparator<I_CmsResource>`	`COMPARE_DATE_RELEASED` A comparator for the release date of two resources.
`static java.util.Comparator<I_CmsResource>`	`COMPARE_ROOT_PATH` A comparator for the root path of two resources.
`static java.util.Comparator<I_CmsResource>`	`COMPARE_ROOT_PATH_IGNORE_CASE` A comparator for the root path of two resources ignoring case differences.
`static java.util.Comparator<I_CmsResource>`	`COMPARE_ROOT_PATH_IGNORE_CASE_FOLDERS_FIRST` A comparator for the root path of two resources ignoring case differences, putting folders before files.

Method Summary

Methods
Modifier and Type	Method and Description
`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.
`int`	`getLength()` Returns the content length of this resource.
`java.lang.String`	`getName()` Returns the file name of this resource without parent folders, for example `index.html`.
`CmsUUID`	`getProjectLastModified()` Returns the id of the `CmsProject` where this resource has been last modified.
`CmsUUID`	`getResourceId()` Returns the id of the database content record of this resource.
`java.lang.String`	`getRootPath()` Returns the name of this resource with it's full path from the top level root folder, for example `/sites/default/myfolder/index.html`.
`int`	`getSiblingCount()` Returns the number of siblings of this resource, also counting this resource.
`CmsResourceState`	`getState()` Returns the state of this resource.
`CmsUUID`	`getStructureId()` Returns the id of the database structure record of this resource.
`int`	`getTypeId()` Returns the resource type id for this resource.
`CmsUUID`	`getUserCreated()` Returns the id of the `CmsUser` who created this resource.
`CmsUUID`	`getUserLastModified()` Returns the id of the `CmsUser` who made the last modification on this resource.
`int`	`getVersion()` Returns the current version number of this 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.

- Field Detail
  - COMPARE_DATE_LAST_MODIFIED
```
static final java.util.Comparator<I_CmsResource> COMPARE_DATE_LAST_MODIFIED
```
    A comparator for the date last modified of two resources.
  - COMPARE_DATE_RELEASED
```
static final java.util.Comparator<I_CmsResource> COMPARE_DATE_RELEASED
```
    A comparator for the release date of two resources.
    If the release date of a resource is not set, the creation date is used instead.
  - COMPARE_ROOT_PATH
```
static final java.util.Comparator<I_CmsResource> COMPARE_ROOT_PATH
```
    A comparator for the root path of two resources.
  - COMPARE_ROOT_PATH_IGNORE_CASE
```
static final java.util.Comparator<I_CmsResource> COMPARE_ROOT_PATH_IGNORE_CASE
```
    A comparator for the root path of two resources ignoring case differences.
  - COMPARE_ROOT_PATH_IGNORE_CASE_FOLDERS_FIRST
```
static final java.util.Comparator<I_CmsResource> COMPARE_ROOT_PATH_IGNORE_CASE_FOLDERS_FIRST
```
    A comparator for the root path of two resources ignoring case differences, putting folders before files.
- Method Detail
  - getDateContent
```
long getDateContent()
```
    Returns the date of the last modification of the content of this resource.
    
    Returns:
    the date of the last modification of the content of this resource
  - getDateCreated
```
long getDateCreated()
```
    Returns the date of the creation of this resource.
    
    Returns:
    the date of the creation of this resource
  - getDateExpired
```
long getDateExpired()
```
    Returns the expiration date this resource.
    
    Returns:
    the expiration date of this resource
  - getDateLastModified
```
long getDateLastModified()
```
    Returns the date of the last modification of this resource.
    
    Returns:
    the date of the last modification of this resource
  - getDateReleased
```
long getDateReleased()
```
    Returns the release date this resource.
    
    Returns:
    the release date of this resource
  - getFlags
```
int getFlags()
```
    Returns the flags of this resource.
    
    Returns:
    the flags of this resource
  - getLength
```
int getLength()
```
    Returns the content length of this resource.
    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.
    
    Returns:
    the content length of this resource
  - getName
```
java.lang.String getName()
```
    Returns the file name of this resource without parent folders, for example index.html.
    
    Returns:
    the file name of this resource without parent folders
  - getProjectLastModified
```
CmsUUID getProjectLastModified()
```
    Returns the id of the CmsProject where this resource has been last modified.
    
    Returns:
    the id of the CmsProject where this resource has been last modified, or null
  - getResourceId
```
CmsUUID getResourceId()
```
    Returns the id of the database content record of this resource.
    
    Returns:
    the id of the database content record of this resource
  - getRootPath
```
java.lang.String getRootPath()
```
    Returns the name of this resource with it's full path from the top level root folder, for example /sites/default/myfolder/index.html.
    
    Returns:
    name of this resource with it's full path from the top level root folder
  - getSiblingCount
```
int getSiblingCount()
```
    Returns the number of siblings of this resource, also counting this resource.
    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.
    
    Returns:
    the number of siblings of this resource, also counting this resource
  - getState
```
CmsResourceState getState()
```
    Returns the state of this resource.
    
    Returns:
    the state of this resource
  - getStructureId
```
CmsUUID getStructureId()
```
    Returns the id of the database structure record of this resource.
    
    Returns:
    the id of the database structure record of this resource
  - getTypeId
```
int getTypeId()
```
    Returns the resource type id for this resource.
    
    Returns:
    the resource type id of this resource
  - getUserCreated
```
CmsUUID getUserCreated()
```
    Returns the id of the CmsUser who created this resource.
    
    Returns:
    the id of the CmsUser who created this resource
  - getUserLastModified
```
CmsUUID getUserLastModified()
```
    Returns the id of the CmsUser who made the last modification on this resource.
    
    Returns:
    the id of the CmsUser who made the last modification on this resource
  - getVersion
```
int getVersion()
```
    Returns the current version number of this resource.
    
    Returns:
    the current version number of this resource
  - isExpired
```
boolean isExpired(long time)
```
    Returns true if this resource is expired at the given time according to the information stored in getDateExpired().
    
    Parameters:
    time - the time to check the expiration date against
    
    Returns:
    true if this resource is expired at the given time
    See Also:
    isReleased(long), isReleasedAndNotExpired(long)
  - isFile
```
boolean isFile()
```
    Returns true if the resource is a file, i.e. can have no sub-resources.
    
    Returns:
    true if this resource is a file, false otherwise
  - isFolder
```
boolean isFolder()
```
    Returns true if the resource is a folder, i.e. can have sub-resources.
    
    Returns:
    true if this resource is a folder, false otherwise
  - isInternal
```
boolean isInternal()
```
    Checks if the resource is internal.
    This state is stored as bit 1 in the resource flags.
    
    Returns:
    true if the resource is internal, otherwise false
  - isLabeled
```
boolean isLabeled()
```
    Checks if the link has to be labeled with a special icon in the explorer view.
    This state is stored as bit 2 in the resource flags.
    
    Returns:
    true if a link to the resource has to be labeled, otherwise false
  - isReleased
```
boolean isReleased(long time)
```
    Returns true if this resource is released at the given time according to the information stored in getDateReleased().
    
    Parameters:
    time - the time to check the release date against
    
    Returns:
    true if this resource is released at the given time
    See Also:
    isExpired(long), isReleasedAndNotExpired(long)
  - isReleasedAndNotExpired
```
boolean isReleasedAndNotExpired(long time)
```
    Returns 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.
    
    Parameters:
    time - the time to check the release and expiration date against
    
    Returns:
    true if this resource is valid at the given time
    See Also:
    isExpired(long), isReleased(long)
  - isTouched
```
boolean isTouched()
```
    Returns true if this resource was touched.
    
    Returns:
    boolean true if this resource was touched

Interface I_CmsResource

Nested Class Summary

Field Summary

Method Summary

Field Detail

COMPARE_DATE_LAST_MODIFIED

COMPARE_DATE_RELEASED

COMPARE_ROOT_PATH

COMPARE_ROOT_PATH_IGNORE_CASE

COMPARE_ROOT_PATH_IGNORE_CASE_FOLDERS_FIRST

Method Detail

getDateContent

getDateCreated

getDateExpired

getDateLastModified

getDateReleased

getFlags

getLength

getName

getProjectLastModified

getResourceId

getRootPath

getSiblingCount

getState

getStructureId

getTypeId

getUserCreated

getUserLastModified

getVersion

isExpired

isFile

isFolder

isInternal

isLabeled

isReleased

isReleasedAndNotExpired

isTouched