1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_06) on Mon May 15 07:31:54 EDT 2006 -->
<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<TITLE>
ChangeSummary (SDO API incubating-M1 API)
</TITLE>
<META NAME="keywords" CONTENT="commonj.sdo.ChangeSummary interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="ChangeSummary (SDO API incubating-M1 API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ChangeSummary.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
SDO API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
PREV CLASS
<A HREF="../../commonj/sdo/ChangeSummary.Setting.html" title="interface in commonj.sdo"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../index.html?commonj/sdo/ChangeSummary.html" target="_top"><B>FRAMES</B></A>
<A HREF="ChangeSummary.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
commonj.sdo</FONT>
<BR>
Interface ChangeSummary</H2>
<HR>
<DL>
<DT><PRE>public interface <B>ChangeSummary</B></DL>
</PRE>
<P>
A change summary is used to record changes to DataObjects,
allowing applications to efficiently and incrementally update back-end storage when required.
<P>
<P>
<HR>
<P>
<!-- ======== NESTED CLASS SUMMARY ======== -->
<A NAME="nested_class_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Nested Class Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static interface</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../commonj/sdo/ChangeSummary.Setting.html" title="interface in commonj.sdo">ChangeSummary.Setting</A></B></CODE>
<BR>
A setting encapsulates a <A HREF="../../commonj/sdo/Property.html" title="interface in commonj.sdo"><CODE>property</CODE></A> and a corresponding single value of the property's <A HREF="../../commonj/sdo/Property.html#getType()"><CODE>type</CODE></A>.</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../commonj/sdo/ChangeSummary.html#beginLogging()">beginLogging</A></B>()</CODE>
<BR>
Clears the List of <A HREF="../../commonj/sdo/ChangeSummary.html#getChangedDataObjects()"><CODE>changes</CODE></A> and turns change logging on.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../commonj/sdo/ChangeSummary.html#endLogging()">endLogging</A></B>()</CODE>
<BR>
An implementation that requires logging may throw an UnsupportedOperationException.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.util.List</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../commonj/sdo/ChangeSummary.html#getChangedDataObjects()">getChangedDataObjects</A></B>()</CODE>
<BR>
Returns a list consisting of all the <A HREF="../../commonj/sdo/DataObject.html" title="interface in commonj.sdo"><CODE>data objects</CODE></A> that have been changed while <A HREF="../../commonj/sdo/ChangeSummary.html#isLogging()"><CODE>logging</CODE></A>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../commonj/sdo/DataGraph.html" title="interface in commonj.sdo">DataGraph</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../commonj/sdo/ChangeSummary.html#getDataGraph()">getDataGraph</A></B>()</CODE>
<BR>
Returns the <A HREF="../../commonj/sdo/DataGraph.html" title="interface in commonj.sdo"><CODE>data graph</CODE></A> associated with this change summary or null.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../commonj/sdo/DataObject.html" title="interface in commonj.sdo">DataObject</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../commonj/sdo/ChangeSummary.html#getOldContainer(commonj.sdo.DataObject)">getOldContainer</A></B>(<A HREF="../../commonj/sdo/DataObject.html" title="interface in commonj.sdo">DataObject</A> dataObject)</CODE>
<BR>
Returns the value of the <A HREF="../../commonj/sdo/DataObject.html#getContainer()"><CODE>container</CODE></A> data object
at the point when logging <A HREF="../../commonj/sdo/ChangeSummary.html#beginLogging()"><CODE>began</CODE></A>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../commonj/sdo/Property.html" title="interface in commonj.sdo">Property</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../commonj/sdo/ChangeSummary.html#getOldContainmentProperty(commonj.sdo.DataObject)">getOldContainmentProperty</A></B>(<A HREF="../../commonj/sdo/DataObject.html" title="interface in commonj.sdo">DataObject</A> dataObject)</CODE>
<BR>
Returns the value of the <A HREF="../../commonj/sdo/DataObject.html#getContainmentProperty()"><CODE>containment property</CODE></A> data object property
at the point when logging <A HREF="../../commonj/sdo/ChangeSummary.html#beginLogging()"><CODE>began</CODE></A>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../commonj/sdo/Sequence.html" title="interface in commonj.sdo">Sequence</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../commonj/sdo/ChangeSummary.html#getOldSequence(commonj.sdo.DataObject)">getOldSequence</A></B>(<A HREF="../../commonj/sdo/DataObject.html" title="interface in commonj.sdo">DataObject</A> dataObject)</CODE>
<BR>
Returns the value of the <A HREF="../../commonj/sdo/DataObject.html#getSequence(java.lang.String)"><CODE>sequence</CODE></A> for the data object
at the point when logging <A HREF="../../commonj/sdo/ChangeSummary.html#beginLogging()"><CODE>began</CODE></A>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../commonj/sdo/ChangeSummary.Setting.html" title="interface in commonj.sdo">ChangeSummary.Setting</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../commonj/sdo/ChangeSummary.html#getOldValue(commonj.sdo.DataObject, commonj.sdo.Property)">getOldValue</A></B>(<A HREF="../../commonj/sdo/DataObject.html" title="interface in commonj.sdo">DataObject</A> dataObject,
<A HREF="../../commonj/sdo/Property.html" title="interface in commonj.sdo">Property</A> property)</CODE>
<BR>
Returns a <A HREF="../../commonj/sdo/ChangeSummary.Setting.html" title="interface in commonj.sdo"><CODE>setting</CODE></A> for the specified property
representing the property value of the given <code>dataObject</code>
at the point when logging <A HREF="../../commonj/sdo/ChangeSummary.html#beginLogging()"><CODE>began</CODE></A>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.util.List</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../commonj/sdo/ChangeSummary.html#getOldValues(commonj.sdo.DataObject)">getOldValues</A></B>(<A HREF="../../commonj/sdo/DataObject.html" title="interface in commonj.sdo">DataObject</A> dataObject)</CODE>
<BR>
Returns a list of <A HREF="../../commonj/sdo/ChangeSummary.Setting.html" title="interface in commonj.sdo"><CODE>settings</CODE></A>
that represent the property values of the given <code>dataObject</code>
at the point when logging <A HREF="../../commonj/sdo/ChangeSummary.html#beginLogging()"><CODE>began</CODE></A>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../commonj/sdo/DataObject.html" title="interface in commonj.sdo">DataObject</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../commonj/sdo/ChangeSummary.html#getRootObject()">getRootObject</A></B>()</CODE>
<BR>
Returns the ChangeSummary root DataObject - the object from which
changes are tracked.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../commonj/sdo/ChangeSummary.html#isCreated(commonj.sdo.DataObject)">isCreated</A></B>(<A HREF="../../commonj/sdo/DataObject.html" title="interface in commonj.sdo">DataObject</A> dataObject)</CODE>
<BR>
Returns whether or not the specified data object was created while <A HREF="../../commonj/sdo/ChangeSummary.html#isLogging()"><CODE>logging</CODE></A>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../commonj/sdo/ChangeSummary.html#isDeleted(commonj.sdo.DataObject)">isDeleted</A></B>(<A HREF="../../commonj/sdo/DataObject.html" title="interface in commonj.sdo">DataObject</A> dataObject)</CODE>
<BR>
Returns whether or not the specified data object was deleted while <A HREF="../../commonj/sdo/ChangeSummary.html#isLogging()"><CODE>logging</CODE></A>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../commonj/sdo/ChangeSummary.html#isLogging()">isLogging</A></B>()</CODE>
<BR>
Indicates whether change logging is on (<code>true</code>) or off (<code>false</code>).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../commonj/sdo/ChangeSummary.html#isModified(commonj.sdo.DataObject)">isModified</A></B>(<A HREF="../../commonj/sdo/DataObject.html" title="interface in commonj.sdo">DataObject</A> dataObject)</CODE>
<BR>
Returns whether or not the specified data object was updated while <A HREF="../../commonj/sdo/ChangeSummary.html#isLogging()"><CODE>logging</CODE></A>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../commonj/sdo/ChangeSummary.html#undoChanges()">undoChanges</A></B>()</CODE>
<BR>
This method is intended for use by service implementations only.</TD>
</TR>
</TABLE>
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="isLogging()"><!-- --></A><H3>
isLogging</H3>
<PRE>
boolean <B>isLogging</B>()</PRE>
<DL>
<DD>Indicates whether change logging is on (<code>true</code>) or off (<code>false</code>).
<P>
<DD><DL>
<DT><B>Returns:</B><DD><code>true</code> if change logging is on.<DT><B>See Also:</B><DD><A HREF="../../commonj/sdo/ChangeSummary.html#beginLogging()"><CODE>beginLogging()</CODE></A>,
<A HREF="../../commonj/sdo/ChangeSummary.html#endLogging()"><CODE>endLogging()</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getDataGraph()"><!-- --></A><H3>
getDataGraph</H3>
<PRE>
<A HREF="../../commonj/sdo/DataGraph.html" title="interface in commonj.sdo">DataGraph</A> <B>getDataGraph</B>()</PRE>
<DL>
<DD>Returns the <A HREF="../../commonj/sdo/DataGraph.html" title="interface in commonj.sdo"><CODE>data graph</CODE></A> associated with this change summary or null.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the data graph.<DT><B>See Also:</B><DD><A HREF="../../commonj/sdo/DataGraph.html#getChangeSummary()"><CODE>DataGraph.getChangeSummary()</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getChangedDataObjects()"><!-- --></A><H3>
getChangedDataObjects</H3>
<PRE>
java.util.List <B>getChangedDataObjects</B>()</PRE>
<DL>
<DD>Returns a list consisting of all the <A HREF="../../commonj/sdo/DataObject.html" title="interface in commonj.sdo"><CODE>data objects</CODE></A> that have been changed while <A HREF="../../commonj/sdo/ChangeSummary.html#isLogging()"><CODE>logging</CODE></A>.
<p>
The <A HREF="../../commonj/sdo/ChangeSummary.html#isCreated(commonj.sdo.DataObject)"><CODE>new</CODE></A> and <A HREF="../../commonj/sdo/ChangeSummary.html#isModified(commonj.sdo.DataObject)"><CODE>modified</CODE></A> objects in the List are references to objects
associated with this ChangeSummary.
The <A HREF="../../commonj/sdo/ChangeSummary.html#isDeleted(commonj.sdo.DataObject)"><CODE>deleted</CODE></A> objects in the List are references to objects
at the time that event logging was enabled;
<p> Each changed object must have exactly one of the following methods return true:
<A HREF="../../commonj/sdo/ChangeSummary.html#isCreated(commonj.sdo.DataObject)"><CODE>isCreated</CODE></A>,
<A HREF="../../commonj/sdo/ChangeSummary.html#isDeleted(commonj.sdo.DataObject)"><CODE>isDeleted</CODE></A>, or
<A HREF="../../commonj/sdo/ChangeSummary.html#isModified(commonj.sdo.DataObject)"><CODE>isModified</CODE></A>.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>a list of changed data objects.<DT><B>See Also:</B><DD><A HREF="../../commonj/sdo/ChangeSummary.html#isCreated(commonj.sdo.DataObject)"><CODE>isCreated(DataObject)</CODE></A>,
<A HREF="../../commonj/sdo/ChangeSummary.html#isDeleted(commonj.sdo.DataObject)"><CODE>isDeleted(DataObject)</CODE></A>,
<A HREF="../../commonj/sdo/ChangeSummary.html#isModified(commonj.sdo.DataObject)"><CODE>isModified(DataObject)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="isCreated(commonj.sdo.DataObject)"><!-- --></A><H3>
isCreated</H3>
<PRE>
boolean <B>isCreated</B>(<A HREF="../../commonj/sdo/DataObject.html" title="interface in commonj.sdo">DataObject</A> dataObject)</PRE>
<DL>
<DD>Returns whether or not the specified data object was created while <A HREF="../../commonj/sdo/ChangeSummary.html#isLogging()"><CODE>logging</CODE></A>.
Any object that was added to the scope
but was not in the scope when logging began,
will be considered created.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>dataObject</CODE> - the data object in question.
<DT><B>Returns:</B><DD><code>true</code> if the specified data object was created.<DT><B>See Also:</B><DD><A HREF="../../commonj/sdo/ChangeSummary.html#getChangedDataObjects()"><CODE>getChangedDataObjects()</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="isDeleted(commonj.sdo.DataObject)"><!-- --></A><H3>
isDeleted</H3>
<PRE>
boolean <B>isDeleted</B>(<A HREF="../../commonj/sdo/DataObject.html" title="interface in commonj.sdo">DataObject</A> dataObject)</PRE>
<DL>
<DD>Returns whether or not the specified data object was deleted while <A HREF="../../commonj/sdo/ChangeSummary.html#isLogging()"><CODE>logging</CODE></A>.
Any object that is not in scope but was in scope when logging began
will be considered deleted.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>dataObject</CODE> - the data object in question.
<DT><B>Returns:</B><DD><code>true</code> if the specified data object was deleted.<DT><B>See Also:</B><DD><A HREF="../../commonj/sdo/ChangeSummary.html#getChangedDataObjects()"><CODE>getChangedDataObjects()</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getOldValues(commonj.sdo.DataObject)"><!-- --></A><H3>
getOldValues</H3>
<PRE>
java.util.List <B>getOldValues</B>(<A HREF="../../commonj/sdo/DataObject.html" title="interface in commonj.sdo">DataObject</A> dataObject)</PRE>
<DL>
<DD>Returns a list of <A HREF="../../commonj/sdo/ChangeSummary.Setting.html" title="interface in commonj.sdo"><CODE>settings</CODE></A>
that represent the property values of the given <code>dataObject</code>
at the point when logging <A HREF="../../commonj/sdo/ChangeSummary.html#beginLogging()"><CODE>began</CODE></A>.
<p>In the case of a <A HREF="../../commonj/sdo/ChangeSummary.html#isDeleted(commonj.sdo.DataObject)"><CODE>deleted</CODE></A> object,
the List will include settings for all the Properties.
<p> An old value setting indicates the value at the
point logging begins. A setting is only produced for
<A HREF="../../commonj/sdo/ChangeSummary.html#isModified(commonj.sdo.DataObject)"><CODE>modified</CODE></A> objects if
either the old value differs from the current value or
if the isSet differs from the current value.
<p> No settings are produced for <A HREF="../../commonj/sdo/ChangeSummary.html#isCreated(commonj.sdo.DataObject)"><CODE>created</CODE></A> objects.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>dataObject</CODE> - the object in question.
<DT><B>Returns:</B><DD>a list of settings.<DT><B>See Also:</B><DD><A HREF="../../commonj/sdo/ChangeSummary.html#getChangedDataObjects()"><CODE>getChangedDataObjects()</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="beginLogging()"><!-- --></A><H3>
beginLogging</H3>
<PRE>
void <B>beginLogging</B>()</PRE>
<DL>
<DD>Clears the List of <A HREF="../../commonj/sdo/ChangeSummary.html#getChangedDataObjects()"><CODE>changes</CODE></A> and turns change logging on.
No operation occurs if logging is already on.
<P>
<DD><DL>
<DT><B>See Also:</B><DD><A HREF="../../commonj/sdo/ChangeSummary.html#endLogging()"><CODE>endLogging()</CODE></A>,
<A HREF="../../commonj/sdo/ChangeSummary.html#isLogging()"><CODE>isLogging()</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="endLogging()"><!-- --></A><H3>
endLogging</H3>
<PRE>
void <B>endLogging</B>()</PRE>
<DL>
<DD>An implementation that requires logging may throw an UnsupportedOperationException.
Turns change logging off. No operation occurs if logging is already off.
<P>
<DD><DL>
<DT><B>See Also:</B><DD><A HREF="../../commonj/sdo/ChangeSummary.html#beginLogging()"><CODE>beginLogging()</CODE></A>,
<A HREF="../../commonj/sdo/ChangeSummary.html#isLogging()"><CODE>isLogging()</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="isModified(commonj.sdo.DataObject)"><!-- --></A><H3>
isModified</H3>
<PRE>
boolean <B>isModified</B>(<A HREF="../../commonj/sdo/DataObject.html" title="interface in commonj.sdo">DataObject</A> dataObject)</PRE>
<DL>
<DD>Returns whether or not the specified data object was updated while <A HREF="../../commonj/sdo/ChangeSummary.html#isLogging()"><CODE>logging</CODE></A>.
An object that was contained in the scope when logging began
and remains in the scope when logging ends will be considered potentially modified.
<p> An object considered modified must have at least one old value setting.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>dataObject</CODE> - the data object in question.
<DT><B>Returns:</B><DD><code>true</code> if the specified data object was modified.<DT><B>See Also:</B><DD><A HREF="../../commonj/sdo/ChangeSummary.html#getChangedDataObjects()"><CODE>getChangedDataObjects()</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getRootObject()"><!-- --></A><H3>
getRootObject</H3>
<PRE>
<A HREF="../../commonj/sdo/DataObject.html" title="interface in commonj.sdo">DataObject</A> <B>getRootObject</B>()</PRE>
<DL>
<DD>Returns the ChangeSummary root DataObject - the object from which
changes are tracked.
When a DataGraph is used, this is the same as getDataGraph().getRootObject().
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the ChangeSummary root DataObject</DL>
</DD>
</DL>
<HR>
<A NAME="getOldValue(commonj.sdo.DataObject, commonj.sdo.Property)"><!-- --></A><H3>
getOldValue</H3>
<PRE>
<A HREF="../../commonj/sdo/ChangeSummary.Setting.html" title="interface in commonj.sdo">ChangeSummary.Setting</A> <B>getOldValue</B>(<A HREF="../../commonj/sdo/DataObject.html" title="interface in commonj.sdo">DataObject</A> dataObject,
<A HREF="../../commonj/sdo/Property.html" title="interface in commonj.sdo">Property</A> property)</PRE>
<DL>
<DD>Returns a <A HREF="../../commonj/sdo/ChangeSummary.Setting.html" title="interface in commonj.sdo"><CODE>setting</CODE></A> for the specified property
representing the property value of the given <code>dataObject</code>
at the point when logging <A HREF="../../commonj/sdo/ChangeSummary.html#beginLogging()"><CODE>began</CODE></A>.
<p>Returns null if the property was not modified and
has not been <A HREF="../../commonj/sdo/ChangeSummary.html#isDeleted(commonj.sdo.DataObject)"><CODE>deleted</CODE></A>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>dataObject</CODE> - the object in question.<DD><CODE>property</CODE> - the property of the object.
<DT><B>Returns:</B><DD>the Setting for the specified property.<DT><B>See Also:</B><DD><A HREF="../../commonj/sdo/ChangeSummary.html#getChangedDataObjects()"><CODE>getChangedDataObjects()</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getOldContainer(commonj.sdo.DataObject)"><!-- --></A><H3>
getOldContainer</H3>
<PRE>
<A HREF="../../commonj/sdo/DataObject.html" title="interface in commonj.sdo">DataObject</A> <B>getOldContainer</B>(<A HREF="../../commonj/sdo/DataObject.html" title="interface in commonj.sdo">DataObject</A> dataObject)</PRE>
<DL>
<DD>Returns the value of the <A HREF="../../commonj/sdo/DataObject.html#getContainer()"><CODE>container</CODE></A> data object
at the point when logging <A HREF="../../commonj/sdo/ChangeSummary.html#beginLogging()"><CODE>began</CODE></A>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>dataObject</CODE> - the object in question.
<DT><B>Returns:</B><DD>the old container data object.</DL>
</DD>
</DL>
<HR>
<A NAME="getOldContainmentProperty(commonj.sdo.DataObject)"><!-- --></A><H3>
getOldContainmentProperty</H3>
<PRE>
<A HREF="../../commonj/sdo/Property.html" title="interface in commonj.sdo">Property</A> <B>getOldContainmentProperty</B>(<A HREF="../../commonj/sdo/DataObject.html" title="interface in commonj.sdo">DataObject</A> dataObject)</PRE>
<DL>
<DD>Returns the value of the <A HREF="../../commonj/sdo/DataObject.html#getContainmentProperty()"><CODE>containment property</CODE></A> data object property
at the point when logging <A HREF="../../commonj/sdo/ChangeSummary.html#beginLogging()"><CODE>began</CODE></A>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>dataObject</CODE> - the object in question.
<DT><B>Returns:</B><DD>the old containment property.</DL>
</DD>
</DL>
<HR>
<A NAME="getOldSequence(commonj.sdo.DataObject)"><!-- --></A><H3>
getOldSequence</H3>
<PRE>
<A HREF="../../commonj/sdo/Sequence.html" title="interface in commonj.sdo">Sequence</A> <B>getOldSequence</B>(<A HREF="../../commonj/sdo/DataObject.html" title="interface in commonj.sdo">DataObject</A> dataObject)</PRE>
<DL>
<DD>Returns the value of the <A HREF="../../commonj/sdo/DataObject.html#getSequence(java.lang.String)"><CODE>sequence</CODE></A> for the data object
at the point when logging <A HREF="../../commonj/sdo/ChangeSummary.html#beginLogging()"><CODE>began</CODE></A>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>dataObject</CODE> - the object in question.
<DT><B>Returns:</B><DD>the old containment property.</DL>
</DD>
</DL>
<HR>
<A NAME="undoChanges()"><!-- --></A><H3>
undoChanges</H3>
<PRE>
void <B>undoChanges</B>()</PRE>
<DL>
<DD>This method is intended for use by service implementations only.
Undoes all changes in the log to restore the tree of
DataObjects to its original state when logging began.
isLogging() is unchanged. The log is cleared.
<P>
<DD><DL>
<DT><B>See Also:</B><DD><A HREF="../../commonj/sdo/ChangeSummary.html#beginLogging()"><CODE>beginLogging()</CODE></A>,
<A HREF="../../commonj/sdo/ChangeSummary.html#endLogging()"><CODE>endLogging()</CODE></A>,
<A HREF="../../commonj/sdo/ChangeSummary.html#isLogging()"><CODE>isLogging()</CODE></A></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ChangeSummary.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
SDO API</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
PREV CLASS
<A HREF="../../commonj/sdo/ChangeSummary.Setting.html" title="interface in commonj.sdo"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../index.html?commonj/sdo/ChangeSummary.html" target="_top"><B>FRAMES</B></A>
<A HREF="ChangeSummary.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
-
</BODY>
</HTML>
|
