org.cyclos.model.users.users

Enum BasicProfileField

java.lang.Object

java.lang.Enum<BasicProfileField>

org.cyclos.model.users.users.BasicProfileField

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BasicProfileField>, ProfileField

public enum BasicProfileField
extends java.lang.Enum<BasicProfileField>
implements ProfileField

Contains built-in fields in an user profile

Author:

luis

Property Summary

Type	Property and Description
Property<java.lang.Boolean,?>	hide Returns the property which can be used to hide the field

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACCOUNT_NUMBER
ADDRESS
EMAIL
FULL_NAME
IMAGE
LOGIN_NAME
PHONE

Field Summary

Fields inherited from interface org.cyclos.model.users.users.ProfileField

PROPERTY_NAME

Method Summary

Modifier and Type	Method and Description
boolean	allowManagePrivacy() Returns whether this field allows users to manage privacy
java.lang.String	getAlias() Returns the first alias
java.util.Set<java.lang.String>	getAliases()
static BasicProfileField	getByAlias(java.lang.String alias) Returns a basic profile field by alias, or null if no match
Property<java.lang.Boolean,?>	hideProperty() Returns the property which can be used to hide the field
boolean	isAllowedForOperator() Returns whether this field is allowed for operators
boolean	isSimple() Returns true is this basic profile field is a simple one, that is, LOGIN_NAME, FULL_NAME and EMAIL.
Property<java.lang.String,?>	property() Returns the property for simple profile fields, or null if not a simple profile field
boolean	readOnly() Returns whether this field is always read only (i.e., never typed by the user)
static java.util.Set<BasicProfileField>	simple() Returns the simple profile fields.
static BasicProfileField	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static BasicProfileField[]	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

FULL_NAME

public static final BasicProfileField FULL_NAME

LOGIN_NAME

public static final BasicProfileField LOGIN_NAME

EMAIL

public static final BasicProfileField EMAIL

PHONE

public static final BasicProfileField PHONE

ADDRESS

public static final BasicProfileField ADDRESS

ACCOUNT_NUMBER

public static final BasicProfileField ACCOUNT_NUMBER

IMAGE

public static final BasicProfileField IMAGE

Property Detail

hide

public Property<java.lang.Boolean,?> hideProperty

Returns the property which can be used to hide the field

Method Detail

values

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

Returns:

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

valueOf

public static BasicProfileField valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getByAlias

public static BasicProfileField getByAlias(java.lang.String alias)

Returns a basic profile field by alias, or null if no match

simple

public static java.util.Set<BasicProfileField> simple()

Returns the simple profile fields.

See Also:

isSimple()

allowManagePrivacy

public boolean allowManagePrivacy()

Returns whether this field allows users to manage privacy

getAlias

public java.lang.String getAlias()

Returns the first alias

getAliases

public java.util.Set<java.lang.String> getAliases()

hideProperty

public Property<java.lang.Boolean,?> hideProperty()

Returns the property which can be used to hide the field

isAllowedForOperator

public boolean isAllowedForOperator()

Returns whether this field is allowed for operators

isSimple

public boolean isSimple()

Returns true is this basic profile field is a simple one, that is, LOGIN_NAME, FULL_NAME and EMAIL. All simple profile fields (and only them) have non-null property()

property

public Property<java.lang.String,?> property()

Returns the property for simple profile fields, or null if not a simple profile field

readOnly

public boolean readOnly()

Returns whether this field is always read only (i.e., never typed by the user)