oracle.toplink.essentials.changesets.ObjectChangeSet Maven / Gradle / Ivy
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the "License"). You may not use this file except
* in compliance with the License.
*
* You can obtain a copy of the license at
* glassfish/bootstrap/legal/CDDLv1.0.txt or
* https://glassfish.dev.java.net/public/CDDLv1.0.html.
* See the License for the specific language governing
* permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* HEADER in each file and include the License file at
* glassfish/bootstrap/legal/CDDLv1.0.txt. If applicable,
* add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your
* own identifying information: Portions Copyright [yyyy]
* [name of copyright owner]
*/
// Copyright (c) 1998, 2007, Oracle. All rights reserved.
package oracle.toplink.essentials.changesets;
import java.util.Vector;
import oracle.toplink.essentials.sessions.Session;
/**
*
* 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.
*
*/
public interface ObjectChangeSet {
boolean equals(ObjectChangeSet objectChange);
/**
* ADVANCED:
* This method will return a collection of the fieldnames of attributes changed in an object.
*/
Vector getChangedAttributeNames();
/**
* ADVANCED:
* This method returns a reference to the collection of changes within this changeSet.
*/
Vector getChanges();
/**
* ADVANCE:
* This method returns the class type that this changeSet Represents.
*/
Class getClassType(Session session);
/**
* ADVANCE:
* This method returns the class Name that this changeSet Represents.
*/
String getClassName();
/**
* 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.
*/
Object getOldKey();
/**
* 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.
*/
Object getNewKey();
/**
* ADVANCED:
* This method returns the primary keys for the object that this change set represents.
*/
Vector getPrimaryKeys();
/**
* ADVANCED:
* This method is used to return the parent ChangeSet.
*/
UnitOfWorkChangeSet getUOWChangeSet();
/**
* ADVANCED:
* This method is used to return the lock value of the object this changeSet represents.
*/
Object getWriteLockValue();
/**
* ADVANCED:
* Returns the change record for the specified attribute name.
*/
ChangeRecord getChangesForAttributeNamed(String attributeName);
/**
* ADVANCED:
* This method will return true if the specified attributue has been changed..
* @param String the name of the attribute to search for.
*/
boolean hasChangeFor(String attributeName);
/**
* ADVANCED:
* Returns true if this particular changeSet has changes.
*/
boolean hasChanges();
/**
* ADVANCED:
* Returns true if this ObjectChangeSet represents a new object.
*/
boolean isNew();
}