Enum Class TdbDefaultFunction
- All Implemented Interfaces:
Serializable
,Comparable<TdbDefaultFunction>
,Constable
An enumeration of the possible function types that can be applied to
fields (of the appropriate type) to serve as default values
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionThe default value should be the current date at the time of initial storageThe default value should be the current time at the time of initial storageThe default value should be the current date and time at the time of initial storageThe normal state of a field is to have no default function at allThe default value should be the user's TRIP username -
Method Summary
Modifier and TypeMethodDescriptiongetName()
Return the TRIPxpi protocol name for the current function identifierstatic TdbDefaultFunction
Retrieve the function ID that matches the provided namestatic TdbDefaultFunction
Returns the enum constant of this class with the specified name.static TdbDefaultFunction[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.Methods inherited from class java.lang.Enum
compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
-
Enum Constant Details
-
NoFunction
The normal state of a field is to have no default function at all -
Username
The default value should be the user's TRIP username -
CommitDate
The default value should be the current date at the time of initial storage -
CommitTime
The default value should be the current time at the time of initial storage -
CommitTStamp
The default value should be the current date and time at the time of initial storage
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified nameNullPointerException
- if the argument is null
-
getTypeof
Retrieve the function ID that matches the provided name- Parameters:
name
- The name to match- Returns:
- The function ID
-
getName
Return the TRIPxpi protocol name for the current function identifier- Returns:
- The name
-