org.ametys.web.pageaccess

Enum ContentAccessManager.ContentAccess

java.lang.Object

java.lang.Enum<ContentAccessManager.ContentAccess>

org.ametys.web.pageaccess.ContentAccessManager.ContentAccess

All Implemented Interfaces:

Serializable, Comparable<ContentAccessManager.ContentAccess>

Enclosing class:

ContentAccessManager

public static enum ContentAccessManager.ContentAccess
extends Enum<ContentAccessManager.ContentAccess>

Enumeration representing a content access status.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALLOWED The content appears on pages with limited access, and the given user can access at least one.
FORBIDDEN The content appears on pages with limited access, but the given user can't access any.
UNRESTRICTED The content can be viewed by all users because of one of these reasons: it appears on a public page it doesn't appear on any page (orphan content) but its sitemap is freely accessible

Method Summary

Modifier and Type	Method and Description
static ContentAccessManager.ContentAccess	valueOf(String name) Returns the enum constant of this type with the specified name.
static ContentAccessManager.ContentAccess[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNRESTRICTED

public static final ContentAccessManager.ContentAccess UNRESTRICTED

The content can be viewed by all users because of one of these reasons:

• it appears on a public page
• it doesn't appear on any page (orphan content) but its sitemap is freely accessible

ALLOWED

public static final ContentAccessManager.ContentAccess ALLOWED

The content appears on pages with limited access, and the given user can access at least one.

FORBIDDEN

public static final ContentAccessManager.ContentAccess FORBIDDEN

The content appears on pages with limited access, but the given user can't access any.

Method Detail

values

public static ContentAccessManager.ContentAccess[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ContentAccessManager.ContentAccess c : ContentAccessManager.ContentAccess.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ContentAccessManager.ContentAccess valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null