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>, 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(Field 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.

Returns:

the name of this field type.

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.

Returns:

the value of this field.

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.

Parameters:

language - the ISO-631 code of a supported language.

Returns:

the value in the specified language.

setValue

public void setValue(String value)
              throws FormException

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

Parameters:

value - the normalized value to set.

Throws:

FormException - when the field is readOnly or when the value format is wrong.

setValue

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

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

Parameters:

value - a textual value.

language - the ISO-631 code of a supported language.

Throws:

FormException - when the field is readOnly or if the value isn't a text.

acceptValue

public boolean acceptValue(String value)

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

Returns:

true if the value format is correct and this field isn't read only. False otherwise.

acceptValue

public boolean acceptValue(String value,
                           String language)

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

Parameters:

value - a textual value.

language - the ISO-631 code of a supported language.

Returns:

true if the local value isn't ill formed and this field isn't read only.

getObjectValue

public Object getObjectValue()

Returns the User referenced by this field.

Returns:

an object representing the value of this field.

setObjectValue

public void setObjectValue(Object value)
                    throws FormException

Set user referenced by this field.

Parameters:

value - an Object representing the value to set.

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.

Parameters:

value - a value

Returns:

true if the value hasn't a wrong type and this field isn't read only.

getStringValue

public String getStringValue()

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

Returns:

the String representation of the value of this field.

setStringValue

public void setStringValue(String value)

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

Parameters:

value - the String value to set

acceptStringValue

public boolean acceptStringValue(String value)

Returns true if this field isn't read only.

Parameters:

value - a String value.

Returns:

true if the value isn't normalized and this field isn't read only.

isNull

public boolean isNull()

Returns true if this field is not set.

Returns:

true if this field is not set. False otherwise.

setNull

public void setNull()
             throws FormException

Set to null this field.

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(Field o)

Compares this field with the specified field.

hashCode

public int hashCode()

Overrides:

hashCode in class Object