Package org.opencms.workplace.editors.directedit

Class CmsDirectEditResourceInfo

java.lang.Object

org.opencms.workplace.editors.directedit.CmsDirectEditResourceInfo

public class CmsDirectEditResourceInfo
extends 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 final 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

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

INACTIVE

public static final CmsDirectEditResourceInfo INACTIVE

Constant for inactive permissions without further resource info.

Constructor Details

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 Details

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