Package org.kuali.rice.kew.framework.document.search

Enum Class StandardResultField

java.lang.Object
java.lang.Enum<StandardResultField>
org.kuali.rice.kew.framework.document.search.StandardResultField
All Implemented Interfaces:
Serializable, Comparable<StandardResultField>, Constable
public enum StandardResultField extends Enum<StandardResultField>
An enumeration which defines fields that are used on the document search screen and subject to customization by specific document types which configure such customizations via the document search framework.
Author:
Kuali Rice Team (rice.collab@kuali.org)

  • Enum Constant Details

  • Method Details

    • values

      public static StandardResultField[] 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

      public static StandardResultField valueOf(String name)
      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 name
      NullPointerException - if the argument is null

    • getStandardFieldName

      public String getStandardFieldName()
      Returns the standard field name of this standard result field as a string.
      Returns:
      the standard result field name

    • getAdditionalFieldNames

      public Set<String> getAdditionalFieldNames()
      Returns additional field names that are valid and can be used to represent this standard result field as a string.
      Returns:
      a set of additional field names

    • isFieldNameValid

      public boolean isFieldNameValid(String fieldName)
      Returns true if the given field name represents a valid field name for this standard result field. The given field name is valid if it is the "standard" field name for this result field, or if it is contained withint the set of additional field names.
      Parameters:
      fieldName - the field name to check
      Returns:
      true if the field name is valid for this result field, false otherwise

    • fromFieldName

      public static StandardResultField fromFieldName(String fieldName)