com.canto.cumulus.fieldvalue

Class UserUIDFieldValue

java.lang.Object

com.canto.cumulus.fieldvalue.UserUIDFieldValue

All Implemented Interfaces:

FieldValue

public class UserUIDFieldValue
extends java.lang.Object
implements FieldValue

A field value wrapper for a "User UID" field. This field type is actually a field value interpretation for a basic field type of "String". The core field value is the user unique ID of a user. This wrapper class provides a fast generation of a display string for a user unique ID. It does not provide backward mapping of display string to a user unique ID. Use Item.getUserUIDValue(com.canto.cumulus.GUID) to get this wrapper class object. You can then use Item.setStringValue(com.canto.cumulus.GUID, String) with a user unique ID to set the field value back into the item.

Since:

8.0

Method Summary

Methods

Modifier and Type	Method and Description
void	clearValue() Clear the field's value.
java.lang.String	getDisplayString() Return the field's value as a string that can be displayed to the user.
java.lang.String	getDisplayString(java.util.Locale locale) Return the field's value as a string that can be displayed to the user.
static java.lang.String	getDisplayString(Server server, java.lang.String userUID)
java.lang.String	getUserUID() Get the user unique ID string for this field value.
boolean	hasValue() Return whether this field has a value.
void	setFromDisplayString(java.util.Locale locale, java.lang.String value) This method is not supported.
void	setFromDisplayString(java.lang.String value) This method is not supported.
void	setUserUID(java.lang.String userUID) Set teh value of this field to a given user unique ID string.
java.lang.String	toString() Same as getDisplayString().

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

hasValue

public boolean hasValue()

Return whether this field has a value.

Specified by:

hasValue in interface FieldValue

Returns:

true if the field has a value, false otherwise.

clearValue

public void clearValue()

Clear the field's value. You need to set the field value of an item using this field value wrapper and then call Item.save() to save this change back to the catalog.

Specified by:

clearValue in interface FieldValue

getDisplayString

public java.lang.String getDisplayString()

Return the field's value as a string that can be displayed to the user. This string consists of the first name, optional middle name and the last name of the user if available.

Specified by:

getDisplayString in interface FieldValue

Returns:

A string representation of the field value to be displayed.

getDisplayString

public java.lang.String getDisplayString(java.util.Locale locale)

Return the field's value as a string that can be displayed to the user. This string consists of the first name, optional middle name and the last name of the user if available.

Specified by:

getDisplayString in interface FieldValue

Parameters:

locale - This parameter is not used.

Returns:

A string representation of the field value to be displayed.

setFromDisplayString

public void setFromDisplayString(java.lang.String value)
                          throws InvalidArgumentException

This method is not supported.

Specified by:

setFromDisplayString in interface FieldValue

Parameters:

value - The display string to set the value from.

Throws:

InvalidArgumentException - if the display string is not of the right format.

setFromDisplayString

public void setFromDisplayString(java.util.Locale locale,
                        java.lang.String value)
                          throws InvalidArgumentException

This method is not supported.

Specified by:

setFromDisplayString in interface FieldValue

Parameters:

locale - The locale to use for formatting and language selection.

value - The display string to set the value from.

Throws:

InvalidArgumentException - if the display string is not of the right format.

getDisplayString

public static java.lang.String getDisplayString(Server server,
                                java.lang.String userUID)

getUserUID

public java.lang.String getUserUID()

Get the user unique ID string for this field value.

Returns:

The user unique ID string.

setUserUID

public void setUserUID(java.lang.String userUID)

Set teh value of this field to a given user unique ID string. You need to set the field value of an item using this field value wrapper and then call Item.save() to save this change back to the catalog.

Parameters:

userUID - The unique ID string for the user.

toString

public java.lang.String toString()

Same as getDisplayString().

Overrides:

toString in class java.lang.Object

Returns:

A user-readable string of this field value (an empty string if it has no value).