com.smartgwt.client.types

Enum WriteToGeneratedFields

java.lang.Object

java.lang.Enum<WriteToGeneratedFields>

com.smartgwt.client.types.WriteToGeneratedFields

All Implemented Interfaces:

ValueEnum, java.io.Serializable, java.lang.Comparable<WriteToGeneratedFields>

public enum WriteToGeneratedFields
extends java.lang.Enum<WriteToGeneratedFields>
implements ValueEnum

Indicates the category of "generated fields" the Smart GWT Server should write values to, if defined on a DSRequest - see writeToGeneratedFields. At the time of writing we only support one such category, but this may be extended in the future.

Enum Constant Summary

Enum Constants

Enum Constant and Description
MODIFIERSANDTIMESTAMPS Write dsRequest-provided values for fields of type modifier, creator, modifierTimestamp and creatorTimestamp

Method Summary

Modifier and Type	Method and Description
java.lang.String	getValue()
static WriteToGeneratedFields	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static WriteToGeneratedFields[]	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

MODIFIERSANDTIMESTAMPS

public static final WriteToGeneratedFields MODIFIERSANDTIMESTAMPS

Write dsRequest-provided values for fields of type modifier, creator, modifierTimestamp and creatorTimestamp

If this enumerated value is used in a Component XML file or server-side DataSource descriptor (.ds.xml file), use the value "modifiersAndTimestamps".

Method Detail

values

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

Returns:

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

valueOf

public static WriteToGeneratedFields valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getValue

public java.lang.String getValue()

Specified by:

getValue in interface ValueEnum