| java.lang.Object
 org.opencms.db.CmsPublishedResource
| CmsPublishedResource | | public class CmsPublishedResource implements Serializable,Comparable(Code) | | 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.
author:
Thomas Weckert
version:
$Revision: 1.35 $
since:
6.0.0
See Also: org.opencms.db.I_CmsProjectDriver.readPublishedResources(CmsDbContextCmsUUID) |
| Inner Class :public static class CmsPublishedResourceState extends CmsResourceState | |
| Field Summary | |
| final public static CmsPublishedResourceState | STATE_MOVED_DESTINATION
Additional state for moved resources, the (new) destination of the moved resource. | | final public static CmsPublishedResourceState | STATE_MOVED_SOURCE
Additional state for moved resources, the (deleted) source of the moved resource. |
| Constructor Summary | |
| public | CmsPublishedResource(CmsResource resource)
| | public | CmsPublishedResource(CmsResource resource, int publishTag)
| | public | CmsPublishedResource(CmsResource resource, int publishTag, CmsResourceState state)
| | public | CmsPublishedResource(CmsUUID structureId, CmsUUID resourceId, int publishTag, String rootPath, int resourceType, boolean isFolder, CmsResourceState resourceState, int siblingCount)
|
| STATE_MOVED_DESTINATION | | final public static CmsPublishedResourceState STATE_MOVED_DESTINATION(Code) | | Additional state for moved resources, the (new) destination of the moved resource.
|
| STATE_MOVED_SOURCE | | final public static CmsPublishedResourceState STATE_MOVED_SOURCE(Code) | | Additional state for moved resources, the (deleted) source of the moved resource.
|
| CmsPublishedResource | | public CmsPublishedResource(CmsResource resource)(Code) | | Creates an object for published VFS resources.
Do not write objects created with this constructor to db, since the publish tag is not set.
Parameters:
resource - an CmsResource object to create a CmsPublishedResource from |
| CmsPublishedResource | | public CmsPublishedResource(CmsResource resource, int publishTag)(Code) | | Creates an object for published VFS resources.
Parameters:
resource - an CmsResource object to create a CmsPublishedResource from
Parameters:
publishTag - the publish Tag |
| CmsPublishedResource | | public CmsPublishedResource(CmsResource resource, int publishTag, CmsResourceState state)(Code) | | Creates an object for published VFS resources.
Parameters:
resource - an CmsResource object to create a CmsPublishedResource from
Parameters:
state - the resource state
Parameters:
publishTag - the publish tag |
| CmsPublishedResource | | public CmsPublishedResource(CmsUUID structureId, CmsUUID resourceId, int publishTag, String rootPath, int resourceType, boolean isFolder, CmsResourceState resourceState, int siblingCount)(Code) | | Creates an object for published VFS resources.
Parameters:
structureId - the structure ID of the published resource
Parameters:
resourceId - the resource ID of the published resource
Parameters:
publishTag - the publish tag
Parameters:
rootPath - the root path of the published resource
Parameters:
resourceType - the type of the published resource
Parameters:
isFolder - indicates if the published resource is a folder or a file
Parameters:
resourceState - the state of the resource *before* it was published
Parameters:
siblingCount - count of siblings of the published resource |
| getMovedState | | public CmsResourceState getMovedState()(Code) | | Returns the resource state including move operation information.
the resource state including move operation information |
| getPublishTag | | public int getPublishTag()(Code) | | Returns the publish tag of the published resource.
the publish tag of the published resource |
| getResourceId | | public CmsUUID getResourceId()(Code) | | Returns the resource ID of the published resource.
the resource ID of the published resource |
| getRootPath | | public String getRootPath()(Code) | | Returns the root path of the published resource.
the root path of the published resource |
| getSiblingCount | | public int getSiblingCount()(Code) | | Returns the count of siblings of the published 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.
the count of siblings of the published resource |
| getState | | public CmsResourceState getState()(Code) | | Returns the resource state of the published resource.
the resource state of the published resource |
| getStructureId | | public CmsUUID getStructureId()(Code) | | Returns the structure ID of the published resource.
the structure ID of the published resource |
| getType | | public int getType()(Code) | | Returns the resource type of the published resource.
the resource type of the published resource |
| isFile | | public boolean isFile()(Code) | | Determines if this resource is a file.
true if this resource is a file, false otherwise |
| isFolder | | public boolean isFolder()(Code) | | Checks if this resource is a folder.
true if this is is a folder |
| isMoved | | public boolean isMoved()(Code) | | Returns true if the resource has been moved.
true if the resource has been moved |
| isVfsResource | | public boolean isVfsResource()(Code) | | Checks if this published resource represents a VFS resource.
If the published resource has no structure id, it is considered to be
no VFS resource.
true if this published resource is a VFS resource |
|
|