com.canto.cumulus.fieldvalue

Interface FieldValue

All Known Implementing Classes:

AssetReference, AssetXRefFieldValue, CategoriesFieldValue, DataSizeFieldValue, DateOnlyFieldValue, LabelFieldValue, LengthInInchFieldValue, RatingFieldValue, ResolutionFieldValue, StringEnumFieldValue, TimeOnlyFieldValue, UserUIDFieldValue, VocabularyFieldValue

public interface FieldValue

Base class for all field value wrapper classes. All field value wrapper class share the ability to check whether the field has a value, clear the value and also to get a display string and set the value from a display string.

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.
boolean	hasValue() Return whether this field has a value.
void	setFromDisplayString(java.util.Locale locale, java.lang.String value) Set the field value from a display string using a specific locale for formatting and language selection.
void	setFromDisplayString(java.lang.String value) Set the field value from a display string.

Method Detail

hasValue

boolean hasValue()

Return whether this field has a value.

Returns:

true if the field has a value, false otherwise.

clearValue

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.

getDisplayString

java.lang.String getDisplayString()

Return the field's value as a string that can be displayed to the user. This method uses the current locale for formatting and language selection.

Returns:

A string representation of the field value to be displayed.

getDisplayString

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

Return the field's value as a string that can be displayed to the user.

Parameters:

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

Returns:

A string representation of the field value to be displayed.

setFromDisplayString

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

Set the field value from a display string. Not every field value wrapper class is able to provide conversion from a string. See the documentation of the derived class for details. 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. This method uses the current locale for formatting and language selection.

Parameters:

value - The display string to set the value from.

Throws:

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

setFromDisplayString

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

Set the field value from a display string using a specific locale for formatting and language selection. Not every field value wrapper class is able to provide conversion from a string. See the documentation of the derived class for details. 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:

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.