Package org.silverpeas.core.contribution.content.form.field

Class UserField

java.lang.Object

org.silverpeas.core.contribution.content.form.AbstractField

org.silverpeas.core.contribution.content.form.field.UserField

All Implemented Interfaces:

Serializable, Comparable, Field

public class UserField
extends AbstractField

A UserField stores a user reference.

See Also:

Field, FieldDisplayer, Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	TYPE	The text field type name.

Fields inherited from interface org.silverpeas.core.contribution.content.form.Field

FILE_PARAM_NAME_SUFFIX, TYPE_FILE

Constructor Summary

Constructors

Constructor	Description
UserField()

Method Summary

Modifier and Type	Method	Description
boolean	acceptObjectValue(Object value)	Returns true if the value is a String and this field isn't read only.
boolean	acceptStringValue(String value)	Returns true if this field isn't read only.
boolean	acceptValue(String value)	Always returns false since a user reference can't be computed from a user name.
boolean	acceptValue(String value, String language)	Always returns false since a user reference can't be computed from a user name.
int	compareTo(Object o)	Compares this field with the specified field.
boolean	equals(Object o)	Tests equality between this field and the specified field.
Object	getObjectValue()	Returns the User referenced by this field.
String	getStringValue()	Returns this field value as a normalized String : a user id
String	getTypeName()	Returns the type name.
String	getUserId()	Returns the user id referenced by this field.
String	getValue()	Returns the string value of this field : aka the user name.
String	getValue(String language)	Returns the local value of this field.
int	hashCode()
boolean	isNull()	Returns true if this field is not set.
boolean	isReadOnly()	Returns true if the value is read only.
void	setNull()	Set to null this field.
void	setObjectValue(Object value)	Set user referenced by this field.
void	setStringValue(String value)	Set this field value from a normalized String : a user id
void	setUserId(String userId)	Set the user id referenced by this field.
void	setValue(String value)	Does nothing since a user reference can't be computed from a user name.
void	setValue(String value, String language)	Does nothing since a user reference can't be computed from a user name.

Methods inherited from class org.silverpeas.core.contribution.content.form.AbstractField

getName, getOccurrence, setName, setOccurrence

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPE

public static final String TYPE

The text field type name.

See Also:

Constant Field Values

Constructor Detail

UserField

public UserField()

Method Detail

getTypeName

public String getTypeName()

Returns the type name.

Specified by:

getTypeName in interface Field

Specified by:

getTypeName in class AbstractField

getUserId

public String getUserId()

Returns the user id referenced by this field.

setUserId

public void setUserId(String userId)

Set the user id referenced by this field.

isReadOnly

public boolean isReadOnly()

Returns true if the value is read only.

getValue

public String getValue()

Returns the string value of this field : aka the user name.

Specified by:

getValue in interface Field

Specified by:

getValue in class AbstractField

getValue

public String getValue(String language)

Returns the local value of this field. There is no local format for a user field, so the language parameter is unused.

Specified by:

getValue in interface Field

Specified by:

getValue in class AbstractField

setValue

public void setValue(String value)
              throws FormException

Does nothing since a user reference can't be computed from a user name.

Specified by:

setValue in interface Field

Specified by:

setValue in class AbstractField

Throws:

FormException - when the field is readOnly or when the string value is ill formed.

setValue

public void setValue(String value,
                     String language)
              throws FormException

Does nothing since a user reference can't be computed from a user name.

Specified by:

setValue in interface Field

Specified by:

setValue in class AbstractField

Throws:

FormException - when the field is readOnly or when the string value is ill formed.

acceptValue

public boolean acceptValue(String value)

Always returns false since a user reference can't be computed from a user name.

Specified by:

acceptValue in interface Field

Specified by:

acceptValue in class AbstractField

acceptValue

public boolean acceptValue(String value,
                           String language)

Always returns false since a user reference can't be computed from a user name.

Specified by:

acceptValue in interface Field

Specified by:

acceptValue in class AbstractField

getObjectValue

public Object getObjectValue()

Returns the User referenced by this field.

Specified by:

getObjectValue in interface Field

Specified by:

getObjectValue in class AbstractField

setObjectValue

public void setObjectValue(Object value)
                    throws FormException

Set user referenced by this field.

Specified by:

setObjectValue in interface Field

Specified by:

setObjectValue in class AbstractField

Throws:

FormException - when the field is readOnly or when the value has a wrong type.

acceptObjectValue

public boolean acceptObjectValue(Object value)

Returns true if the value is a String and this field isn't read only.

Specified by:

acceptObjectValue in interface Field

Specified by:

acceptObjectValue in class AbstractField

getStringValue

public String getStringValue()

Returns this field value as a normalized String : a user id

Specified by:

getStringValue in interface Field

Specified by:

getStringValue in class AbstractField

setStringValue

public void setStringValue(String value)

Set this field value from a normalized String : a user id

Specified by:

setStringValue in interface Field

Specified by:

setStringValue in class AbstractField

acceptStringValue

public boolean acceptStringValue(String value)

Returns true if this field isn't read only.

Specified by:

acceptStringValue in interface Field

Specified by:

acceptStringValue in class AbstractField

isNull

public boolean isNull()

Returns true if this field is not set.

Specified by:

isNull in interface Field

Specified by:

isNull in class AbstractField

setNull

public void setNull()
             throws FormException

Set to null this field.

Specified by:

setNull in interface Field

Specified by:

setNull in class AbstractField

Throws:

FormException - when the field is mandatory or when the field is read only.

equals

public boolean equals(Object o)

Tests equality between this field and the specified field.

Overrides:

equals in class Object

compareTo

public int compareTo(Object o)

Compares this field with the specified field.

Specified by:

compareTo in interface Comparable

Specified by:

compareTo in class AbstractField

hashCode

public int hashCode()

Overrides:

hashCode in class Object