org.opencms.workplace.editors.directedit
Class CmsDirectEditResourceInfo

java.lang.Object
  extended byorg.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
Version:
$Revision: 1.5 $
Author:
Alexander Kandzior

Field Summary
static CmsDirectEditResourceInfo INACTIVE
          Constant for inactive permissions without further resource info.
 
Constructor Summary
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
 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

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 resource
resource - the resource that is to be direct edited
lock - 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 is INACTIVE.

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 is INACTIVE.

Returns:
the resource that is to be direct edited