Skip to main content
Kinetic Community

Enum Field Value

This class represents an enum field value.  It contains data about the selected enumeration option including the option id and the name value of the option.

Instance Methods

id Returns the id of the selected enumeration option.
id= Sets the id of the selected enumeration option.
value Returns the name value of the selected enumeration option.
value= Sets the name value of the selected enumeration option.
to_s Returns the name value of the selected enumeration option.
inspect Returns a specially formatted string representing the EnumFieldValue instance including the id and value of the selected enumeration option.
== This method compares the EnumFieldValue to a given value.  It returns true if the given value is a string that matches the value of the EnumFieldValue.  It returns true if the given value is a number that matches the id of the EnumFieldValue.  It returns the result of the eql? method below if the given value is another EnumFieldValue instance.  In all other cases false will be returned.
eql? This method compares the EnumFieldValue to another EnumFieldValue.  It returns true if the two EnumFieldValue instances share the same id and value.