|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opencms.db.CmsPublishedResource
Represents the state of a published resource *before* it got published.
This allows various subsequent tasks in the Cms app. (e.g. exporting files and folders) to identify published resources after a resource or project was published.
The values to fill this container are read from the Cms publish history database table that is written during each publishing process.
I_CmsProjectDriver.readPublishedResources(CmsDbContext, int, CmsUUID)
,
Serialized FormConstructor Summary | |
CmsPublishedResource(CmsResource resource)
Creates an object for published VFS resources. |
|
CmsPublishedResource(CmsResource resource,
int backupTagId)
Creates an object for published VFS resources. |
|
CmsPublishedResource(CmsUUID structureId,
CmsUUID resourceId,
int backupTagId,
java.lang.String rootPath,
int resourceType,
boolean isFolder,
int resourceState,
int siblingCount)
Creates an object for published VFS resources. |
Method Summary | |
int |
compareTo(java.lang.Object obj)
|
boolean |
equals(java.lang.Object obj)
|
protected void |
finalize()
|
int |
getBackupTagId()
Returns the backup tag ID of the published resource. |
CmsUUID |
getResourceId()
Returns the resource ID of the published resource. |
java.lang.String |
getRootPath()
Returns the root path of the published resource. |
int |
getSiblingCount()
Returns the count of siblings of the published resource. |
int |
getState()
Returns the resource state of the published resource. |
CmsUUID |
getStructureId()
Returns the structure ID of the published resource. |
int |
getType()
Returns the resource type of the published resource. |
int |
hashCode()
|
boolean |
isChanged()
Checks if the resource is changed. |
boolean |
isDeleted()
Checks if the resource is deleted. |
boolean |
isFile()
Determines if this resource is a file. |
boolean |
isFolder()
Checks if this resource is a folder. |
boolean |
isNew()
Checks if the resource is new. |
boolean |
isUnChanged()
Checks if the resource is unchanged. |
boolean |
isVfsResource()
Checks if this published resource represents a VFS resource. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
clone, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public CmsPublishedResource(CmsResource resource)
Do not write objects created with this constructor to db, since the backup tag id is not set.
resource
- an CmsResource object to create a CmsPublishedResource frompublic CmsPublishedResource(CmsResource resource, int backupTagId)
resource
- an CmsResource object to create a CmsPublishedResource frombackupTagId
- the backup tag idpublic CmsPublishedResource(CmsUUID structureId, CmsUUID resourceId, int backupTagId, java.lang.String rootPath, int resourceType, boolean isFolder, int resourceState, int siblingCount)
structureId
- the structure ID of the published resourceresourceId
- the resource ID of the published resourcebackupTagId
- the resource's tag ID in the backup tablesrootPath
- the root path of the published resourceresourceType
- the type of the published resourceisFolder
- indicates if the published resource is a folder or a fileresourceState
- the state of the resource *before* it was publishedsiblingCount
- count of siblings of the published resourceMethod Detail |
public int compareTo(java.lang.Object obj)
compareTo
in interface java.lang.Comparable
Comparable.compareTo(java.lang.Object)
public boolean equals(java.lang.Object obj)
Object.equals(java.lang.Object)
public int getBackupTagId()
public CmsUUID getResourceId()
public java.lang.String getRootPath()
public 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
.
public int getState()
public CmsUUID getStructureId()
public int getType()
public int hashCode()
Object.hashCode()
public boolean isChanged()
public boolean isDeleted()
public boolean isFile()
public boolean isFolder()
public boolean isNew()
public boolean isUnChanged()
public boolean isVfsResource()
If the published resource has no structure id, it is considered to be no VFS resource.
public java.lang.String toString()
Object.toString()
protected void finalize() throws java.lang.Throwable
java.lang.Throwable
Object.finalize()
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |