atg.search.routing.command.search
Class ItemType

java.lang.Object
  extended by atg.core.util.Enum
      extended by atg.search.routing.command.search.ItemType
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable

public class ItemType
extends Enum

Enumeration of item types

See Also:
Serialized Form

Nested Class Summary
static class ItemType.ItemTypeEditor
           
 
Nested classes/interfaces inherited from class atg.core.util.Enum
Enum.EnumEditor, Enum.LocaleEnumEditor
 
Field Summary
static java.lang.String CLASS_VERSION
          Class version string
static ItemType PREF_ANSWER
          Preferred answer item type
static ItemType STRUCTURED
          Structured item type
static ItemType UNSTRUCTURED
          Unstructured item type
 
Constructor Summary
protected ItemType(java.lang.String enumName, int ordinalVal)
          The subclass constructor should be private.
 
Method Summary
static ItemType valueOf(java.lang.String pName)
           
 
Methods inherited from class atg.core.util.Enum
compareTo, getEnumClassInfo, getOrdinal, iterator, iterator, lookup, lookup, lookup, lookup, readResolve, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION
Class version string


STRUCTURED

public static final ItemType STRUCTURED
Structured item type


UNSTRUCTURED

public static final ItemType UNSTRUCTURED
Unstructured item type


PREF_ANSWER

public static final ItemType PREF_ANSWER
Preferred answer item type

Constructor Detail

ItemType

protected ItemType(java.lang.String enumName,
                   int ordinalVal)
The subclass constructor should be private.

The ordinal value is used to compare (done when sorting, for example) two Enum objects and to order the objects in iterators and PropertyEditors. No two instances of a subclass should have the same ordinal value or name. To safely add new Enum subclass instances and preserve previous orderings in containers the best thing to do is to always use a new ordinal value when creating a new instance rather than changing old instance's ordinal value.

If an enum subclass instance is ever removed, there should be a comment in the file that reserves the old ordinal value so that any old serialized files don't accidentally map an old enum to a new enum.

Parameters:
enumName - The name of the instance that will appear in editors and toString().
ordinalVal - The ordinal value
Throws:
java.lang.Error - if the subclass already has an instance name n or if the ordinal number is already used by another instance of the same subclass.
Method Detail

valueOf

public static ItemType valueOf(java.lang.String pName)