oracle.toplink.essentials.changesets.CollectionChangeRecord 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 oracle.toplink.essentials.internal.helper.IdentityHashtable;
/**
*
* Purpose: This interface defines the API for the changeRecord that maintains the changes made to a collection attribute of
* an object.
*
* Description: The CollectionChangeRecord stores a list of objects removed from the collection and a seperate list of objects
* added to a collection
*/
public interface CollectionChangeRecord extends ChangeRecord {
/**
* ADVANCED:
* This method returns the IdentityHashtable that contains the added values to the collection
* and their corresponding ChangeSets.
* @return java.util.Vector
*/
public IdentityHashtable getAddObjectList();
/**
* ADVANCED:
* This method returns the IdentityHashtable that contains the removed values from the collection
* and their corresponding ChangeSets.
* @return java.util.Vector
*/
public IdentityHashtable getRemoveObjectList();
/**
* ADVANCED:
* This method returns true if the change set has changes
* @return boolean
*/
public boolean hasChanges();
}