public class

ContentPermission

extends ConfluenceEntityObject
implements Comparable<T>

java.lang.Object
↳	com.atlassian.core.bean.EntityObject
	↳	com.atlassian.confluence.core.ConfluenceEntityObject
		↳	com.atlassian.confluence.security.ContentPermission

Class Overview

Allows a user to lock content against editing by other users.

Note: the expiry field is currently unused.

Summary

Constants
String	EDIT_PERMISSION
String	VIEW_PERMISSION

Public Constructors
	ContentPermission() This has to be public because the `ReverseDatabinder` requires public default constructors.

Protected Constructors
	ContentPermission(String type, String groupName, String userName)

Public Methods
int	compareTo(Object o)
static ContentPermission	createGroupPermission(String type, String groupName)
static ContentPermission	createUserPermission(String type, String userName)
boolean	equals(Object o)
String	getGroup() This method is deprecated. as of version 2.4. Use `getGroupName()` instead.
String	getGroupName()
ContentPermissionSet	getOwningSet()
String	getType()
String	getUserName() When `isUserPermission()` is true, returns the username of the user who is explicitly permitted by this permission.
int	hashCode()
boolean	isGroupPermission()
boolean	isPermitted(User user) Determine if a user is locked out by the permission.
boolean	isUserPermission()
void	setOwningSet(ContentPermissionSet owningSet)
void	setUserAccessor(UserAccessor userAccessor)
String	toString()

[Expand]

Inherited Methods

From class com.atlassian.confluence.core.ConfluenceEntityObject

From class com.atlassian.core.bean.EntityObject

From class java.lang.Object

From interface java.lang.Comparable

Constants

public static final String EDIT_PERMISSION

Constant Value: "Edit"

public static final String VIEW_PERMISSION

Constant Value: "View"

Public Constructors

public ContentPermission ()

This has to be public because the ReverseDatabinder requires public default constructors.

Protected Constructors

protected ContentPermission (String type, String groupName, String userName)

Public Methods

public int compareTo (Object o)

public static ContentPermission createGroupPermission (String type, String groupName)

public static ContentPermission createUserPermission (String type, String userName)

public boolean equals (Object o)

public String getGroup ()

This method is deprecated.
as of version 2.4. Use getGroupName() instead.

public String getGroupName ()

public ContentPermissionSet getOwningSet ()

public String getType ()

public String getUserName ()

When isUserPermission() is true, returns the username of the user who is explicitly permitted by this permission.

public int hashCode ()

public boolean isGroupPermission ()

public boolean isPermitted (User user)

Determine if a user is locked out by the permission. Note, this does not take into account if the user has a general ability to override a lock (say if they are a global or space-level administrator), lock overrides must be dealt with at a higher level. content level permissions cannot be granted to anonymous users

Parameters

user	the user to test against

Interfaces

Classes

Exceptions