org.eclipse.persistence.descriptors
public class ReturningPolicy extends Object implements Serializable, 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.
Modifier and Type | Class and Description |
---|---|
static class |
ReturningPolicy.Info
INTERNAL:
|
Constructor and Description |
---|
ReturningPolicy() |
Modifier and Type | Method and Description |
---|---|
void |
addFieldForInsert(org.eclipse.persistence.internal.helper.DatabaseField field)
PUBLIC:
|
void |
addFieldForInsert(String qualifiedName)
PUBLIC:
|
void |
addFieldForInsert(String qualifiedName,
Class type)
PUBLIC:
|
void |
addFieldForInsertReturnOnly(org.eclipse.persistence.internal.helper.DatabaseField field)
PUBLIC:
|
void |
addFieldForInsertReturnOnly(String qualifiedName)
PUBLIC:
|
void |
addFieldForInsertReturnOnly(String qualifiedName,
Class type)
PUBLIC:
|
void |
addFieldForUpdate(org.eclipse.persistence.internal.helper.DatabaseField field)
PUBLIC:
|
void |
addFieldForUpdate(String qualifiedName)
PUBLIC:
|
void |
addFieldForUpdate(String qualifiedName,
Class type)
PUBLIC:
|
static boolean |
areCollectionsEqualAsSets(Collection col1,
Collection col2)
INTERNAL:
Compares two Collections as sets (ignoring the order of the elements).
|
Object |
clone()
INTERNAL:
Normally cloned when not yet initialized.
|
ClassDescriptor |
getDescriptor()
PUBLIC:
Return the owner of the policy.
|
org.eclipse.persistence.internal.helper.DatabaseField |
getField(org.eclipse.persistence.internal.helper.DatabaseField field)
INTERNAL:
Returns an equal field held by ReturningPolicy, or null.
|
Vector |
getFieldInfos()
INTERNAL:
|
Vector |
getFieldsToGenerateInsert(org.eclipse.persistence.internal.helper.DatabaseTable table)
INTERNAL:
|
Vector |
getFieldsToGenerateUpdate(org.eclipse.persistence.internal.helper.DatabaseTable table)
INTERNAL:
|
Collection |
getFieldsToMergeInsert()
INTERNAL:
|
Collection |
getFieldsToMergeUpdate()
INTERNAL:
|
boolean |
hasEqualFieldInfos(ReturningPolicy returningPolicyToCompare)
INTERNAL:
Used for testing only
|
boolean |
hasEqualFieldInfos(Vector infosToCompare)
INTERNAL:
Used for testing only
|
boolean |
hasEqualMains(ReturningPolicy policy)
INTERNAL:
Both ReturningPolicies should be initialized
|
void |
initialize(org.eclipse.persistence.internal.sessions.AbstractSession session)
INTERNAL:
|
boolean |
isUsedToSetPrimaryKey()
PUBLIC:
|
void |
setDescriptor(ClassDescriptor descriptor)
INTERNAL:
|
void |
setFieldInfos(Vector infos)
INTERNAL:
|
void |
trimModifyRowForInsert(org.eclipse.persistence.internal.sessions.AbstractRecord modifyRow)
INTERNAL:
|
void |
validationAfterDescriptorInitialization(org.eclipse.persistence.internal.sessions.AbstractSession session)
INTERNAL:
|
public ClassDescriptor getDescriptor()
public Vector getFieldsToGenerateInsert(org.eclipse.persistence.internal.helper.DatabaseTable table)
public Vector getFieldsToGenerateUpdate(org.eclipse.persistence.internal.helper.DatabaseTable table)
public Vector getFieldInfos()
public void setFieldInfos(Vector infos)
public boolean hasEqualFieldInfos(ReturningPolicy returningPolicyToCompare)
public boolean hasEqualFieldInfos(Vector infosToCompare)
public static boolean areCollectionsEqualAsSets(Collection col1, Collection col2)
public Collection getFieldsToMergeInsert()
public Collection getFieldsToMergeUpdate()
public Object clone()
public void setDescriptor(ClassDescriptor descriptor)
public void addFieldForInsert(String qualifiedName)
public void addFieldForInsert(org.eclipse.persistence.internal.helper.DatabaseField field)
public void addFieldForInsertReturnOnly(String qualifiedName)
public void addFieldForInsertReturnOnly(String qualifiedName, Class type)
public void addFieldForInsertReturnOnly(org.eclipse.persistence.internal.helper.DatabaseField field)
public void addFieldForUpdate(String qualifiedName)
public void addFieldForUpdate(org.eclipse.persistence.internal.helper.DatabaseField field)
public void initialize(org.eclipse.persistence.internal.sessions.AbstractSession session)
public boolean hasEqualMains(ReturningPolicy policy)
public void trimModifyRowForInsert(org.eclipse.persistence.internal.sessions.AbstractRecord modifyRow)
public boolean isUsedToSetPrimaryKey()
public void validationAfterDescriptorInitialization(org.eclipse.persistence.internal.sessions.AbstractSession session)
public org.eclipse.persistence.internal.helper.DatabaseField getField(org.eclipse.persistence.internal.helper.DatabaseField field)