org.eclipse.persistence.sessions.changesets

Interface ObjectChangeSet

public interface ObjectChangeSet

Purpose: Provides API to the Class that holds all changes made to a particular Object.

Description: The ObjectChangeSet class represents a single Object registered in the UnitOfWork. It is owned by the larger UnitOfWorkChangeSet.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object objectChange)
java.util.List<java.lang.String>	getChangedAttributeNames() ADVANCED: This method will return a collection of the names of attributes changed in an object.
java.util.List<ChangeRecord>	getChanges() ADVANCED: This method returns a reference to the collection of changes within this changeSet.
ChangeRecord	getChangesForAttributeNamed(java.lang.String attributeName) ADVANCED: Returns the change record for the specified attribute name.
java.lang.String	getClassName() ADVANCE: This method returns the class Name that this changeSet Represents.
java.lang.Class	getClassType(Session session) ADVANCE: This method returns the class type that this changeSet Represents.
java.lang.Object	getId() ADVANCED: This method returns the primary key for the object that this change set represents.
java.lang.Object	getNewKey() ADVANCED: This method returns the key value that this object will be stored under in it's respective Map.
java.lang.Object	getOldKey() ADVANCED: This method returns the key value that this object was stored under in it's respective Map.
java.util.Vector	getPrimaryKeys() Deprecated. since EclipseLink 2.1, replaced by getId()
UnitOfWorkChangeSet	getUOWChangeSet() ADVANCED: This method is used to return the parent ChangeSet.
java.lang.Object	getWriteLockValue() ADVANCED: This method is used to return the lock value of the object this changeSet represents.
boolean	hasChangeFor(java.lang.String attributeName) ADVANCED: This method will return true if the specified attribute has been changed.
boolean	hasChanges() ADVANCED: Returns true if this particular changeSet has changes.
boolean	isNew() ADVANCED: Returns true if this ObjectChangeSet represents a new object.
void	setShouldRecalculateAfterUpdateEvent(boolean shouldRecalculateAfterUpdateEvent) ADVANCED Set whether this ObjectChangeSet should be recalculated after changes in event
boolean	shouldRecalculateAfterUpdateEvent() ADVANCED Returns true if this ObjectChangeSet should be recalculated after changes in event

Method Detail

equals

boolean equals(java.lang.Object objectChange)

Overrides:

equals in class java.lang.Object

getChangedAttributeNames

java.util.List<java.lang.String> getChangedAttributeNames()

ADVANCED: This method will return a collection of the names of attributes changed in an object.

getChanges

java.util.List<ChangeRecord> getChanges()

ADVANCED: This method returns a reference to the collection of changes within this changeSet.

getClassType

java.lang.Class getClassType(Session session)

ADVANCE: This method returns the class type that this changeSet Represents.

getClassName

java.lang.String getClassName()

ADVANCE: This method returns the class Name that this changeSet Represents.

getOldKey

java.lang.Object getOldKey()

ADVANCED: This method returns the key value that this object was stored under in it's respective Map. This is old relevant for collection mappings that use a Map.

getNewKey

java.lang.Object getNewKey()

ADVANCED: This method returns the key value that this object will be stored under in it's respective Map. This is old relevant for collection mappings that use a Map.

getPrimaryKeys

@Deprecated
java.util.Vector getPrimaryKeys()

Deprecated. since EclipseLink 2.1, replaced by getId()

ADVANCED: This method returns the primary key for the object that this change set represents.

See Also:

getId()

getId

java.lang.Object getId()

ADVANCED: This method returns the primary key for the object that this change set represents.

getUOWChangeSet

UnitOfWorkChangeSet getUOWChangeSet()

ADVANCED: This method is used to return the parent ChangeSet.

getWriteLockValue

java.lang.Object getWriteLockValue()

ADVANCED: This method is used to return the lock value of the object this changeSet represents.

getChangesForAttributeNamed

ChangeRecord getChangesForAttributeNamed(java.lang.String attributeName)

ADVANCED: Returns the change record for the specified attribute name.

hasChangeFor

boolean hasChangeFor(java.lang.String attributeName)

ADVANCED: This method will return true if the specified attribute has been changed.

Parameters:

attributeName - the name of the attribute to search for.

hasChanges

boolean hasChanges()

ADVANCED: Returns true if this particular changeSet has changes.

isNew

boolean isNew()

ADVANCED: Returns true if this ObjectChangeSet represents a new object.

shouldRecalculateAfterUpdateEvent

boolean shouldRecalculateAfterUpdateEvent()

ADVANCED Returns true if this ObjectChangeSet should be recalculated after changes in event

Returns:

setShouldRecalculateAfterUpdateEvent

void setShouldRecalculateAfterUpdateEvent(boolean shouldRecalculateAfterUpdateEvent)

ADVANCED Set whether this ObjectChangeSet should be recalculated after changes in event