KickJava   Java API By Example, From Geeks To Geeks.

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


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
25 /**
26  * <p>
27  * <b>Purpose</b>: To Provide API to the UnitOfWorkChangeSet.
28  * <p>
29  * <b>Description</b>:The UnitOfWorkChangeSet contains all of the individual ObjectChangeSets. It is stored and used by the UnitOfWork
30  * <p>
31  */
32 public interface UnitOfWorkChangeSet {
33
34     /**
35      * ADVANCED:
36      * This method returns a reference to the collection. Not All ChangeSets that Exist in this list may have changes
37      * @return oracle.toplink.essentials.internal.helper.IdentityHashtable
38      */
39     public oracle.toplink.essentials.internal.helper.IdentityHashtable getAllChangeSets();
40
41     /**
42      * ADVANCED:
43      * This method returns the reference to the deleted objects from the changeSet
44      * @return oracle.toplink.essentials.internal.helper.IdentityHashtable
45      */
46     public oracle.toplink.essentials.internal.helper.IdentityHashtable getDeletedObjects();
47
48     /**
49      * ADVANCED:
50      * Get ChangeSet for a particular clone
51      * @return oracle.toplink.essentials.changesets.ObjectChangeSet the changeSet that represents a particular clone
52      */
53     public ObjectChangeSet getObjectChangeSetForClone(Object JavaDoc clone);
54
55     /**
56      * ADVANCED:
57      * This method returns the Clone for a particular changeSet
58      * @return Object the clone represented by the changeSet
59      */
60     public Object JavaDoc getUOWCloneForObjectChangeSet(ObjectChangeSet changeSet);
61
62     /**
63      * ADVANCED:
64      * Returns true if the Unit Of Work change Set has changes
65      * @return boolean
66      */
67     public boolean hasChanges();
68 }
69
Popular Tags