Package de.xima.fc.form.common.fieldname

Enum EBuiltinFieldNameConventions

java.lang.Object

java.lang.Enum<EBuiltinFieldNameConventions>

de.xima.fc.form.common.fieldname.EBuiltinFieldNameConventions

All Implemented Interfaces:

IXItemFieldNameConventions, Serializable, Comparable<EBuiltinFieldNameConventions>

public enum EBuiltinFieldNameConventions
extends Enum<EBuiltinFieldNameConventions>
implements IXItemFieldNameConventions

The IXItemFieldNameConventions for the builtin items (that have special conventions).

Since:

8.1.0

Author:

XIMA MEDIA GmbH

Enum Constant Summary

Enum Constants

Enum Constant	Description
X_APPOINTMENT	The field name conventions for XAppointment items.
X_SELECT	The field name conventions for XSelect items.
X_UPLOAD	The field name conventions for XUpload items.

Method Summary

Modifier and Type	Method	Description
abstract Set<String>	findRelatedBaseNames(String baseName)	Given the base name of a form item, returns the set of additional related names that might be submitted.
abstract String	resolveRelatedBaseName(String relatedBaseName)	Given the base name of a request value, finds the base name of the form item that produced this request value.
static EBuiltinFieldNameConventions	valueOf(String name)	Returns the enum constant of this type with the specified name.
static EBuiltinFieldNameConventions[]	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

X_APPOINTMENT

public static final EBuiltinFieldNameConventions X_APPOINTMENT

The field name conventions for XAppointment items.

Multiple additional text fields with various suffixes such as .typeuuid are _date are created to submit additional or related data.

X_SELECT

public static final EBuiltinFieldNameConventions X_SELECT

The field name conventions for XSelect items.

When XPropertyEnum.autocomplete is enabled, an additional text field with the suffix _autocomplete is created.

When the element is displayed as questions, multiple elements such as sel1_quest_1, sel1_quest_2 etc. are created.

X_UPLOAD

public static final EBuiltinFieldNameConventions X_UPLOAD

The field name conventions for XUpload items.

An additional text field with the suffix .uuid contains the UUID of the attachment that was created from the upload file.

For automatic uploads, an additional input field with the suffix .ajaxuuid is created.

Method Detail

values

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

Returns:

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

valueOf

public static EBuiltinFieldNameConventions valueOf(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:

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

NullPointerException - if the argument is null

findRelatedBaseNames

public abstract Set<String> findRelatedBaseNames(String baseName)

Description copied from interface: IXItemFieldNameConventions

Given the base name of a form item, returns the set of additional related names that might be submitted.

For example, when the form contains an autocomplete element with the name sel1, the form submission might include a value for the related name sel1_autocomplete in addition to the value for the name sel1. This method should then return a set with the one value sel1_autocomplete when called with the base name sel1.

This is the inverse operation of resolveRelatedBaseName. If this method is given a string X and returns a set of strings Y, then resolveRelatedBaseName must return X if given any of the strings Y.

This method is never given a derived name for repeated form fields. Repeated form fields use the convention tf1_dyn_fs1_0 (item base name tf1, container base name fs1, repetition ID 0).

Specified by:

findRelatedBaseNames in interface IXItemFieldNameConventions

Parameters:

baseName - The base name of an item.

Returns:

A set of related base names. null or the empty set when there are no related base name.

resolveRelatedBaseName

public abstract String resolveRelatedBaseName(String relatedBaseName)

Description copied from interface: IXItemFieldNameConventions

Given the base name of a request value, finds the base name of the form item that produced this request value.

For example, when the form contains an autocomplete element with the name sel1, the form submission might include a value for the related name sel1_autocomplete in addition to the value for the name sel1. This method should then return sel1 when given the name sel1_autocomplete.

This method is never given a derived name for repeated form fields. Repeated form fields use the convention tf1_dyn_fs1_0 (item base name tf1, container base name fs1, repetition ID 0).

This is the inverse operation of findRelatedBaseNames. If findRelatedBaseNames is given a string X and returns a set of strings Y , then this method must return . X if given any of the strings Y.

Specified by:

resolveRelatedBaseName in interface IXItemFieldNameConventions

Parameters:

relatedBaseName - A related base name to resolve.

Returns:

The resolved base name. null, the empty string, or the argument itself when the name is unknown to this conventions instance.