org.kuali.rice.krad.util
Enum NoteType

java.lang.Object
  extended by java.lang.Enum<NoteType>
      extended by org.kuali.rice.krad.util.NoteType
All Implemented Interfaces:
Serializable, Comparable<NoteType>, Coded

public enum NoteType
extends Enum<NoteType>
implements Coded

Defines the different types of Notes which can be used with the notes and attachments framework.

Author:
Kuali Rice Team (rice.collab@kuali.org)

Enum Constant Summary
BUSINESS_OBJECT
           
DOCUMENT_HEADER
           
 
Method Summary
 String getCode()
          The code value for this object.
static NoteType valueOf(String name)
          Returns the enum constant of this type with the specified name.
static NoteType[] 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

BUSINESS_OBJECT

public static final NoteType BUSINESS_OBJECT

DOCUMENT_HEADER

public static final NoteType DOCUMENT_HEADER
Method Detail

values

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

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

valueOf

public static NoteType valueOf(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:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null

getCode

public String getCode()
Description copied from interface: Coded
The code value for this object. In general a code value cannot be null or a blank string.

Specified by:
getCode in interface Coded
Returns:
the code value for this object.


Copyright © 2005-2013 The Kuali Foundation. All Rights Reserved.