com.adobe.cq.mobile.dps

Enum ProtectedAccess

java.lang.Object

java.lang.Enum<ProtectedAccess>

com.adobe.cq.mobile.dps.ProtectedAccess

All Implemented Interfaces:

Serializable, Comparable<ProtectedAccess>

public enum ProtectedAccess
extends Enum<ProtectedAccess>

Enum of DPS ProtectedAccess

Since:

CQ5.6

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLOSED Deprecated. Use PROTECTED instead.
FREE Article can be freely shared on touch devices but are subject to paywall threshold rules for the web viewer (new in R26) (only available for articles that target viewer 26 or greater)
METERED Article can be shared after publishing via social sharing, subject to paywall threshold rules on both touch devices and in the web viewer.
OPEN Deprecated. Use METERED instead.
PROTECTED Article cannot be shared.

Method Summary

Modifier and Type	Method and Description
static ProtectedAccess	getProtectedAccess(String value) Return the ProtectedAccess object for the specified value
String	getValue()
static boolean	isProtectedAccess(String value) Returns true if this is a ProtectedAccess and false otherwise.
static ProtectedAccess	valueOf(String name) Returns the enum constant of this type with the specified name.
static ProtectedAccess[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PROTECTED

public static final ProtectedAccess PROTECTED

Article cannot be shared. Closed maps to “Protected” in the Folio Producer Editor setting.

CLOSED

@Deprecated
public static final ProtectedAccess CLOSED

Deprecated. Use PROTECTED instead.

METERED

public static final ProtectedAccess METERED

Article can be shared after publishing via social sharing, subject to paywall threshold rules on both touch devices and in the web viewer. Open maps to “Metered” in the Folio Producer Editor setting.

OPEN

@Deprecated
public static final ProtectedAccess OPEN

Deprecated. Use METERED instead.

FREE

public static final ProtectedAccess FREE

Article can be freely shared on touch devices but are subject to paywall threshold rules for the web viewer (new in R26) (only available for articles that target viewer 26 or greater)

Method Detail

values

public static ProtectedAccess[] 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 (ProtectedAccess c : ProtectedAccess.values())
    System.out.println(c);

Returns:

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

valueOf

public static ProtectedAccess 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

getValue

public String getValue()

Returns:

ProtectedAccess value

isProtectedAccess

public static final boolean isProtectedAccess(String value)

Returns true if this is a ProtectedAccess and false otherwise.

Parameters:

value - The value to check

Returns:

true if a ProtectedAccess and false otherwise

getProtectedAccess

public static final ProtectedAccess getProtectedAccess(String value)

Return the ProtectedAccess object for the specified value

Parameters:

value - used to specify the ProtectedAccess

Returns:

a ProtectedAccess for the specified value or null if invalid