JADE Java Persistence API
1.0

com.jadeworld.jade.persistence
Enum ReferenceUpdateMode

java.lang.Object
  extended by java.lang.Enum<ReferenceUpdateMode>
      extended by com.jadeworld.jade.persistence.ReferenceUpdateMode
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<ReferenceUpdateMode>

public enum ReferenceUpdateMode
extends java.lang.Enum<ReferenceUpdateMode>

Holds the values of the @OneToOne, @OneToMany, @ManyToMany, and @ManyToOne updateMode attributes. This attribute determines what is automatically done by JADE and what by user logic, with references and their inverses.

Author:
JADE Development Centre, Jade Software Corporation Ltd.

Enum Constant Summary
AUTOMATIC
          The AUTOMATIC option means the property is maintained by JADE whenever the property at the other end of the relationship (the inverse) is updated.
DEFAULT
          The DEFAULT option specifies that the actual relationship type is based on the relationshipType of the relationship, with values as in the ReferenceRelationshipType class.
MAN_AUTO
          The MAN_AUTO option specifies that either end of the relationship can be updated in user logic.
MANUAL
          The MANUAL option specifies that the property is maintained by your Java logic.
 
Method Summary
static ReferenceUpdateMode valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static ReferenceUpdateMode[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

DEFAULT

public static final ReferenceUpdateMode DEFAULT
The DEFAULT option specifies that the actual relationship type is based on the relationshipType of the relationship, with values as in the ReferenceRelationshipType class. A peer-to-peer relationship is MAN_AUTO, a parent relationship is AUTOMATIC, and a child relationship is MANUAL.


MANUAL

public static final ReferenceUpdateMode MANUAL
The MANUAL option specifies that the property is maintained by your Java logic.


AUTOMATIC

public static final ReferenceUpdateMode AUTOMATIC
The AUTOMATIC option means the property is maintained by JADE whenever the property at the other end of the relationship (the inverse) is updated. Automatic references cannot be updated in user logic.


MAN_AUTO

public static final ReferenceUpdateMode MAN_AUTO
The MAN_AUTO option specifies that either end of the relationship can be updated in user logic. The other side of the relationship is automatically maintained by JADE.

Method Detail

values

public static final ReferenceUpdateMode[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(ReferenceUpdateMode c : ReferenceUpdateMode.values())
        System.out.println(c);

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

valueOf

public static ReferenceUpdateMode valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

JADE Java Persistence API
1.0

Copyright © 2007 Jade Software Corporation