KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > oracle > toplink > essentials > changesets > CollectionChangeRecord


1 /*
2  * The contents of this file are subject to the terms
3  * of the Common Development and Distribution License
4  * (the "License"). You may not use this file except
5  * in compliance with the License.
6  *
7  * You can obtain a copy of the license at
8  * glassfish/bootstrap/legal/CDDLv1.0.txt or
9  * https://glassfish.dev.java.net/public/CDDLv1.0.html.
10  * See the License for the specific language governing
11  * permissions and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL
14  * HEADER in each file and include the License file at
15  * glassfish/bootstrap/legal/CDDLv1.0.txt. If applicable,
16  * add the following below this CDDL HEADER, with the
17  * fields enclosed by brackets "[]" replaced with your
18  * own identifying information: Portions Copyright [yyyy]
19  * [name of copyright owner]
20  */
21 // Copyright (c) 1998, 2005, Oracle. All rights reserved.
22 package oracle.toplink.essentials.changesets;
23
24 import oracle.toplink.essentials.internal.helper.IdentityHashtable;
25
26 /**
27  * <p>
28  * <b>Purpose</b>: This interface defines the API for the changeRecord that maintains the changes made to a collection attribute of
29  * an object.
30  * <p>
31  * <b>Description</b>: The CollectionChangeRecord stores a list of objects removed from the collection and a seperate list of objects
32  * added to a collection
33  */
34 public interface CollectionChangeRecord extends ChangeRecord {
35
36     /**
37      * ADVANCED:
38      * This method returns the IdentityHashtable that contains the added values to the collection
39      * and their corresponding ChangeSets.
40      * @return java.util.Vector
41      */
42     public IdentityHashtable getAddObjectList();
43
44     /**
45      * ADVANCED:
46      * This method returns the IdentityHashtable that contains the removed values from the collection
47      * and their corresponding ChangeSets.
48      * @return java.util.Vector
49      */
50     public IdentityHashtable getRemoveObjectList();
51
52     /**
53      * ADVANCED:
54      * This method returns true if the change set has changes
55      * @return boolean
56      */
57     public boolean hasChanges();
58 }
59
Popular Tags