Package 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
    Description
    boolean
    equals(Object objectChange)
     
    List<String>
    getChangedAttributeNames()
    ADVANCED: This method will return a collection of the names of attributes changed in an object.
    List<ChangeRecord>
    getChanges()
    ADVANCED: This method returns a reference to the collection of changes within this changeSet.
    ChangeRecord
    getChangesForAttributeNamed(String attributeName)
    ADVANCED: Returns the change record for the specified attribute name.
    String
    getClassName()
    ADVANCE: This method returns the class Name that this changeSet Represents.
    Class
    getClassType(Session session)
    ADVANCE: This method returns the class type that this changeSet Represents.
    Object
    getId()
    ADVANCED: This method returns the primary key for the object that this change set represents.
    Object
    getNewKey()
    ADVANCED: This method returns the key value that this object will be stored under in it's respective Map.
    Object
    getOldKey()
    ADVANCED: This method returns the key value that this object was stored under in it's respective Map.
    UnitOfWorkChangeSet
    getUOWChangeSet()
    ADVANCED: This method is used to return the parent ChangeSet.
    Object
    getWriteLockValue()
    ADVANCED: This method is used to return the lock value of the object this changeSet represents.
    boolean
    hasChangeFor(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 Details

    • equals

      boolean equals(Object objectChange)
      Overrides:
      equals in class Object

    • getChangedAttributeNames

      List<String> getChangedAttributeNames()
      ADVANCED: This method will return a collection of the names of attributes changed in an object.

    • getChanges

      List<ChangeRecord> getChanges()
      ADVANCED: This method returns a reference to the collection of changes within this changeSet.

    • getClassType

      Class getClassType(Session session)
      ADVANCE: This method returns the class type that this changeSet Represents.

    • getClassName

      String getClassName()
      ADVANCE: This method returns the class Name that this changeSet Represents.

    • getOldKey

      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

      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.

    • getId

      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

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

    • getChangesForAttributeNamed

      ChangeRecord getChangesForAttributeNamed(String attributeName)
      ADVANCED: Returns the change record for the specified attribute name.

    • hasChangeFor

      boolean hasChangeFor(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