Package org.cyclos.model.users.products

Enum AccountVisibility

java.lang.Object

java.lang.Enum<AccountVisibility>

org.cyclos.model.users.products.AccountVisibility

All Implemented Interfaces:

Serializable, Comparable<AccountVisibility>, HasDefault, HasMessageKey

public enum AccountVisibility
extends Enum<AccountVisibility>
implements HasMessageKey, HasDefault

Possible options for an user account being visible to the owner. This will allow users to hide his own accounts. It is not related to permissions, or even performance, but for convenience.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALWAYS_VISIBLE	The account is always visible and the owner can't change its visibility. This is the behaviour for Cyclos 4.14.
DEFAULT_HIDDEN	The user account is hidden by default but the user can change its visibility.
DEFAULT_VISIBLE	The user account is visible by default but the user can change its visibility.

Field Summary

Fields

Modifier and Type	Field	Description
static String	ALWAYS_VISIBLE_VALUE

Method Summary

Modifier and Type	Method	Description
boolean	canConfigure()	Returns whether the account owner can configure the account visibility
MessageKey	getMessageKey()
boolean	isDefault()
boolean	shouldBeVisible()	Returns whether this visibility means the account is visible
static AccountVisibility	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AccountVisibility[]	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

ALWAYS_VISIBLE

public static final AccountVisibility ALWAYS_VISIBLE

The account is always visible and the owner can't change its visibility.
This is the behaviour for Cyclos 4.14.

DEFAULT_VISIBLE

public static final AccountVisibility DEFAULT_VISIBLE

The user account is visible by default but the user can change its visibility.

DEFAULT_HIDDEN

public static final AccountVisibility DEFAULT_HIDDEN

The user account is hidden by default but the user can change its visibility.

Field Detail

ALWAYS_VISIBLE_VALUE

public static final String ALWAYS_VISIBLE_VALUE

Method Detail

values

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

Returns:

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

valueOf

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

canConfigure

public boolean canConfigure()

Returns whether the account owner can configure the account visibility

getMessageKey

public MessageKey getMessageKey()

Specified by:

getMessageKey in interface HasMessageKey

isDefault

public boolean isDefault()

Specified by:

isDefault in interface HasDefault

shouldBeVisible

public boolean shouldBeVisible()

Returns whether this visibility means the account is visible