01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * // Copyright (c) 1998, 2007, Oracle. All rights reserved.
05: *
06: *
07: * The contents of this file are subject to the terms of either the GNU
08: * General Public License Version 2 only ("GPL") or the Common Development
09: * and Distribution License("CDDL") (collectively, the "License"). You
10: * may not use this file except in compliance with the License. You can obtain
11: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
12: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
13: * language governing permissions and limitations under the License.
14: *
15: * When distributing the software, include this License Header Notice in each
16: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
17: * Sun designates this particular file as subject to the "Classpath" exception
18: * as provided by Sun in the GPL Version 2 section of the License file that
19: * accompanied this code. If applicable, add the following below the License
20: * Header, with the fields enclosed by brackets [] replaced by your own
21: * identifying information: "Portions Copyrighted [year]
22: * [name of copyright owner]"
23: *
24: * Contributor(s):
25: *
26: * If you wish your version of this file to be governed by only the CDDL or
27: * only the GPL Version 2, indicate your decision by adding "[Contributor]
28: * elects to include this software in this distribution under the [CDDL or GPL
29: * Version 2] license." If you don't indicate a single choice of license, a
30: * recipient has the option to distribute your version of this file under
31: * either the CDDL, the GPL Version 2 or to extend the choice of license to
32: * its licensees as provided above. However, if you add GPL Version 2 code
33: * and therefore, elected the GPL Version 2 license, then the option applies
34: * only if the new code is made subject to such option by the copyright
35: * holder.
36: */
37: package oracle.toplink.essentials.changesets;
38:
39: /**
40: * <p>
41: * <b>Purpose</b>: To Provide API to the UnitOfWorkChangeSet.
42: * <p>
43: * <b>Description</b>:The UnitOfWorkChangeSet contains all of the individual ObjectChangeSets. It is stored and used by the UnitOfWork
44: * <p>
45: */
46: public interface UnitOfWorkChangeSet {
47:
48: /**
49: * ADVANCED:
50: * This method returns a reference to the collection. Not All ChangeSets that Exist in this list may have changes
51: * @return oracle.toplink.essentials.internal.helper.IdentityHashtable
52: */
53: public oracle.toplink.essentials.internal.helper.IdentityHashtable getAllChangeSets();
54:
55: /**
56: * ADVANCED:
57: * This method returns the reference to the deleted objects from the changeSet
58: * @return oracle.toplink.essentials.internal.helper.IdentityHashtable
59: */
60: public oracle.toplink.essentials.internal.helper.IdentityHashtable getDeletedObjects();
61:
62: /**
63: * ADVANCED:
64: * Get ChangeSet for a particular clone
65: * @return oracle.toplink.essentials.changesets.ObjectChangeSet the changeSet that represents a particular clone
66: */
67: public ObjectChangeSet getObjectChangeSetForClone(Object clone);
68:
69: /**
70: * ADVANCED:
71: * This method returns the Clone for a particular changeSet
72: * @return Object the clone represented by the changeSet
73: */
74: public Object getUOWCloneForObjectChangeSet(
75: ObjectChangeSet changeSet);
76:
77: /**
78: * ADVANCED:
79: * Returns true if the Unit Of Work change Set has changes
80: * @return boolean
81: */
82: public boolean hasChanges();
83: }
|