ForeignKeyAction (DataNucleus Core 5.1.13-SNAPSHOT API)

java.lang.Object
- org.datanucleus.metadata.ForeignKeyAction

All Implemented Interfaces:

Serializable
```
public class ForeignKeyAction
extends Object
implements Serializable
```
Foreign keys represent a consistency constraint in the database that must be maintained. This class enumerates the actions which happens when foreign-keys are updated or deleted.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static ForeignKeyAction`	`CASCADE` update/delete-action="cascade".
`static ForeignKeyAction`	`DEFAULT` update/delete-action="default".
`static ForeignKeyAction`	`NONE` update/delete-action="none".
`static ForeignKeyAction`	`NULL` update/delete-action="null".
`static ForeignKeyAction`	`RESTRICT` update/delete-action="restrict".

Constructor Summary

Constructors
Modifier Constructor and Description

protected ForeignKeyAction(int i)
constructor

Constructors
Modifier	Constructor and Description
`protected`	`ForeignKeyAction(int i)` constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`static ForeignKeyAction`	`getForeignKeyAction(String value)` Return ForeignKeyDeleteAction from String.
`protected int`	`getType()` Accessor for the type.
`int`	`hashCode()`
`String`	`toString()` Returns a string representation of the object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - CASCADE
```
public static final ForeignKeyAction CASCADE
```
    update/delete-action="cascade". The database will automatically delete all rows that refer to the row being deleted
  - RESTRICT
```
public static final ForeignKeyAction RESTRICT
```
    update/delete-action="restrict". The user is required to explicitly make the relationship valid by application code
  - NULL
```
public static final ForeignKeyAction NULL
```
    update/delete-action="null". The database will automatically nullify the columns in all rows that refer to the row being deleted
  - DEFAULT
```
public static final ForeignKeyAction DEFAULT
```
    update/delete-action="default". The database will automatically set the columns in all rows that refer to the row being deleted to their default value
  - NONE
```
public static final ForeignKeyAction NONE
```
    update/delete-action="none". No foreign-key should be created.
- Constructor Detail
  - ForeignKeyAction
```
protected ForeignKeyAction(int i)
```
    constructor
    
    Parameters:
    
    i - type id
- Method Detail
  - toString
```
public String toString()
```
    Returns a string representation of the object.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of the object.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - getType
```
protected int getType()
```
    Accessor for the type.
    
    Returns:
    
    The type
  - getForeignKeyAction
```
public static ForeignKeyAction getForeignKeyAction(String value)
```
    Return ForeignKeyDeleteAction from String.
    
    Parameters:
    
    value - delete-action attribute value
    
    Returns:
    
    Instance of ForeignKeyDeleteAction. If value invalid, return null.

Class ForeignKeyAction

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CASCADE

RESTRICT

NULL

DEFAULT

NONE

Constructor Detail

ForeignKeyAction

Method Detail

toString

hashCode

equals

getType

getForeignKeyAction