Package org.opencms.db

Class CmsSubscriptionReadMode

java.lang.Object

org.opencms.util.A_CmsModeIntEnumeration

org.opencms.db.CmsSubscriptionReadMode

All Implemented Interfaces:

Serializable

public final class CmsSubscriptionReadMode
extends A_CmsModeIntEnumeration

The read modes to get subscribed resources of a user or group.

Since:

8.0

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final CmsSubscriptionReadMode	ALL	Subscription read mode: all.
static final String	MODE_NAME_ALL	String representation of the read mode: all.
static final String	MODE_NAME_UNVISITED	String representation of the read mode: unvisited.
static final String	MODE_NAME_VISITED	String representation of the read mode: visited.
static final CmsSubscriptionReadMode	UNVISITED	Subscription read mode: unvisited.
static final CmsSubscriptionReadMode	VISITED	Subscription read mode: visited.

Method Summary

Modifier and Type	Method	Description
protected Object	clone()
boolean	isAll()	Returns if the mode is set to ALL.
boolean	isUnVisited()	Returns if the mode is set to UNVISITED.
boolean	isVisited()	Returns if the mode is set to VISITED.
static CmsSubscriptionReadMode	modeForName(String modeName)	Returns the subscription read mode for the given mode name.
String	toString()
static CmsSubscriptionReadMode	valueOf(int type)	Returns the subscription read mode for the given mode value.

Methods inherited from class org.opencms.util.A_CmsModeIntEnumeration

equals, getMode, hashCode

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

MODE_NAME_ALL

public static final String MODE_NAME_ALL

String representation of the read mode: all.

See Also:

• Constant Field Values

MODE_NAME_UNVISITED

public static final String MODE_NAME_UNVISITED

String representation of the read mode: unvisited.

See Also:

• Constant Field Values

MODE_NAME_VISITED

public static final String MODE_NAME_VISITED

String representation of the read mode: visited.

See Also:

• Constant Field Values

ALL

public static final CmsSubscriptionReadMode ALL

Subscription read mode: all.

UNVISITED

public static final CmsSubscriptionReadMode UNVISITED

Subscription read mode: unvisited.

VISITED

public static final CmsSubscriptionReadMode VISITED

Subscription read mode: visited.

Method Details

modeForName

public static CmsSubscriptionReadMode modeForName(String modeName)

Returns the subscription read mode for the given mode name.

Parameters:

modeName - the subscription read mode name to get the read mode for

Returns:

the subscription read mode for the given mode name

valueOf

public static CmsSubscriptionReadMode valueOf(int type)

Returns the subscription read mode for the given mode value.

This is used only for serialization and should not be accessed for other purposes.

Parameters:

type - the subscription read mode value to get the read mode for

Returns:

the subscription read mode for the given mode value

isAll

public boolean isAll()

Returns if the mode is set to ALL.

Returns:

true if the mode is set to ALL, otherwise false

isUnVisited

public boolean isUnVisited()

Returns if the mode is set to UNVISITED.

Returns:

true if the mode is set to UNVISITED, otherwise false

isVisited

public boolean isVisited()

Returns if the mode is set to VISITED.

Returns:

true if the mode is set to VISITED, otherwise false

toString

public String toString()

Overrides:

toString in class A_CmsModeIntEnumeration

See Also:

• A_CmsModeIntEnumeration.toString()

clone

protected Object clone()

Overrides:

clone in class Object

See Also:

• Object.clone()