KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > emf > ecore > sdo > EChangeSummary


1 /**
2  * <copyright>
3  *
4  * Copyright (c) 2003-2004 IBM Corporation and others.
5  * All rights reserved. This program and the accompanying materials
6  * are made available under the terms of the Eclipse Public License v1.0
7  * which accompanies this distribution, and is available at
8  * http://www.eclipse.org/legal/epl-v10.html
9  *
10  * Contributors:
11  * IBM - Initial API and implementation
12  *
13  * </copyright>
14  *
15  * $Id: EChangeSummary.java,v 1.7 2005/06/08 06:24:25 nickb Exp $
16  */
17 package org.eclipse.emf.ecore.sdo;
18
19 import org.eclipse.emf.ecore.change.ChangeDescription;
20
21 import commonj.sdo.ChangeSummary;
22 import commonj.sdo.DataObject;
23 import commonj.sdo.Property;
24
25 /**
26  * <!-- begin-user-doc -->
27  * A representation of the model object '<em><b>EChange Summary</b></em>'.
28  * <!-- end-user-doc -->
29  *
30  * <p>
31  * The following features are supported:
32  * <ul>
33  * <li>{@link org.eclipse.emf.ecore.sdo.EChangeSummary#getEDataGraph <em>EData Graph</em>}</li>
34  * </ul>
35  * </p>
36  *
37  * @see org.eclipse.emf.ecore.sdo.SDOPackage#getEChangeSummary()
38  * @model
39  * @generated
40  */
41 public interface EChangeSummary extends ChangeDescription, ChangeSummary
42 {
43   /**
44    * Returns the value of the '<em><b>EData Graph</b></em>' reference.
45    * It is bidirectional and its opposite is '{@link org.eclipse.emf.ecore.sdo.EDataGraph#getEChangeSummary <em>EChange Summary</em>}'.
46    * <!-- begin-user-doc -->
47    * <p>
48    * If the meaning of the '<em>EData Graph</em>' reference isn't clear,
49    * there really should be more of a description here...
50    * </p>
51    * <!-- end-user-doc -->
52    * @return the value of the '<em>EData Graph</em>' reference.
53    * @see #setEDataGraph(EDataGraph)
54    * @see org.eclipse.emf.ecore.sdo.SDOPackage#getEChangeSummary_EDataGraph()
55    * @see org.eclipse.emf.ecore.sdo.EDataGraph#getEChangeSummary
56    * @model opposite="eChangeSummary" resolveProxies="false" required="true" transient="true"
57    * @generated
58    */
59   EDataGraph getEDataGraph();
60
61   /**
62    * Sets the value of the '{@link org.eclipse.emf.ecore.sdo.EChangeSummary#getEDataGraph <em>EData Graph</em>}' reference.
63    * <!-- begin-user-doc -->
64    * <!-- end-user-doc -->
65    * @param value the new value of the '<em>EData Graph</em>' reference.
66    * @see #getEDataGraph()
67    * @generated
68    */
69   void setEDataGraph(EDataGraph value);
70
71   /**
72    * <!-- begin-user-doc -->
73    * <!-- end-user-doc -->
74    * @model
75    * @generated
76    */
77   void summarize();
78
79   /**
80    * <!-- begin-user-doc -->
81    * <!-- end-user-doc -->
82    * @model
83    * @generated
84    */
85   void resumeLogging();
86
87   /**
88    * Returns whether or not the specified data object was changed while {@link #isLogging logging}.
89    * Any modified object that was {@link DataObject#getDataGraph contained} in the data graph when
90    * logging began and remains in the graph when logging ends will be considered changed.
91    * @param dataObject the data object in question.
92    * @return <code>true</code> if the specified data object was changed.
93    * @see #getChangedDataObjects
94    */
95   boolean isChanged(DataObject dataObject);
96
97   /**
98    * Returns a {@link commonj.sdo.ChangeSummary.Setting setting} for the specified property
99    * representing the property value of the given <code>dataObject</code>
100    * at the point when logging {@link #beginLogging() began}.
101    * <p>Returns null if the property has not changed and
102    * has not been {@link #isDeleted(DataObject) deleted}.
103    * @param dataObject the object in question.
104    * @param property the property of the object.
105    * @return the setting for the specified property.
106    * @see #getChangedDataObjects
107    */
108   Setting getOldValue(DataObject dataObject, Property property);
109
110   /**
111    * Returns the value of the {@link DataObject#getContainer container} data object
112    * at the point when logging {@link #beginLogging() began}.
113    * @param dataObject the object in question.
114    * @return the old container data object.
115    */
116   DataObject getOldContainer(DataObject dataObject);
117
118   /**
119    * Returns the value of the {@link DataObject#getContainmentProperty containment property} data
120    * object property at the point when logging {@link #beginLogging() began}.
121    * @param dataObject the object in question.
122    * @return the old containment property.
123    */
124   Property getOldContainmentProperty(DataObject dataObject);
125
126 } // EChangeSummary
127
Popular Tags