Oracle Fusion Middleware Java API Reference for Oracle TopLink (Deprecated)
11g Release 1 (11.1.1)

B32476-04

oracle.toplink.descriptors
Class ReturningPolicy

java.lang.Object
  extended by oracle.toplink.descriptors.ReturningPolicy
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable

public class ReturningPolicy
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

Purpose: Allows for INSERT or UPDATE operations to return values back into the object being written. This allows for table default values, trigger or stored procedures computed values to be set back into the object. This can be used with generated SQL on the Oracle platform using the RETURNING clause, or through stored procedures on other platforms.

Since:
TopLink 10.1.3
See Also:
Serialized Form

Constructor Summary
ReturningPolicy()
           
 
Method Summary
 void addFieldForInsert(DatabaseField field)
          
 void addFieldForInsert(java.lang.String qualifiedName)
          
 void addFieldForInsert(java.lang.String qualifiedName, java.lang.Class type)
          
 void addFieldForInsertReturnOnly(DatabaseField field)
          
 void addFieldForInsertReturnOnly(java.lang.String qualifiedName)
          
 void addFieldForInsertReturnOnly(java.lang.String qualifiedName, java.lang.Class type)
          
 void addFieldForUpdate(DatabaseField field)
          
 void addFieldForUpdate(java.lang.String qualifiedName)
          
 void addFieldForUpdate(java.lang.String qualifiedName, java.lang.Class type)
          
 ClassDescriptor getDescriptor()
          Return the owner of the policy.
 boolean isUsedToSetPrimaryKey()
          
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ReturningPolicy

public ReturningPolicy()
Method Detail

getDescriptor

public ClassDescriptor getDescriptor()
Return the owner of the policy.


addFieldForInsert

public void addFieldForInsert(java.lang.String qualifiedName)


addFieldForInsert

public void addFieldForInsert(java.lang.String qualifiedName,
                              java.lang.Class type)


addFieldForInsert

public void addFieldForInsert(DatabaseField field)


addFieldForInsertReturnOnly

public void addFieldForInsertReturnOnly(java.lang.String qualifiedName)


addFieldForInsertReturnOnly

public void addFieldForInsertReturnOnly(java.lang.String qualifiedName,
                                        java.lang.Class type)


addFieldForInsertReturnOnly

public void addFieldForInsertReturnOnly(DatabaseField field)


addFieldForUpdate

public void addFieldForUpdate(java.lang.String qualifiedName)


addFieldForUpdate

public void addFieldForUpdate(java.lang.String qualifiedName,
                              java.lang.Class type)


addFieldForUpdate

public void addFieldForUpdate(DatabaseField field)


isUsedToSetPrimaryKey

public boolean isUsedToSetPrimaryKey()


Copyright © 1998, 2012, Oracle. All Rights Reserved.