Class CmsDirectEditResourceInfo
- java.lang.Object
-
- org.opencms.workplace.editors.directedit.CmsDirectEditResourceInfo
-
public class CmsDirectEditResourceInfo extends java.lang.Object
Contains information about a resource that is direct edited.For example, the information in this class allows implementations of a
I_CmsDirectEditProvider
to render HTML with extended information about the resource displayed on the buttons.- Since:
- 6.2.3
-
-
Field Summary
Fields Modifier and Type Field Description static CmsDirectEditResourceInfo
INACTIVE
Constant for inactive permissions without further resource info.
-
Constructor Summary
Constructors Constructor Description CmsDirectEditResourceInfo(CmsDirectEditPermissions permissions)
Creates a new direct edit resource info container without any specific information about the resource to be direct edited.CmsDirectEditResourceInfo(CmsDirectEditPermissions permissions, CmsResource resource, CmsLock lock)
Creates a new direct edit resource info container.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CmsLock
getLock()
Returns the lock on the direct edit resource.CmsDirectEditPermissions
getPermissions()
Returns the direct edit permissions of the resource.CmsResource
getResource()
Returns the resource that is to be direct edited.
-
-
-
Field Detail
-
INACTIVE
public static final CmsDirectEditResourceInfo INACTIVE
Constant for inactive permissions without further resource info.
-
-
Constructor Detail
-
CmsDirectEditResourceInfo
public CmsDirectEditResourceInfo(CmsDirectEditPermissions permissions)
Creates a new direct edit resource info container without any specific information about the resource to be direct edited.- Parameters:
permissions
- the direct edit permissions of the resource
-
CmsDirectEditResourceInfo
public CmsDirectEditResourceInfo(CmsDirectEditPermissions permissions, CmsResource resource, CmsLock lock)
Creates a new direct edit resource info container.- Parameters:
permissions
- the direct edit permissions of the resourceresource
- the resource that is to be direct editedlock
- the lock on the direct edit resource
-
-
Method Detail
-
getLock
public CmsLock getLock()
Returns the lock on the direct edit resource.This may be
null
in case the result isINACTIVE
.- Returns:
- the lock on the direct edit resource
-
getPermissions
public CmsDirectEditPermissions getPermissions()
Returns the direct edit permissions of the resource.The result is ensured not to be
null
.- Returns:
- the direct edit permissions of the resource
-
getResource
public CmsResource getResource()
Returns the resource that is to be direct edited.This may be
null
in case the result isINACTIVE
.- Returns:
- the resource that is to be direct edited
-
-