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
|
/**
* Copyright (c) 2004 - 2011 Eike Stepper (Berlin, Germany) and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Eike Stepper - initial API and implementation
*/
package org.eclipse.emf.cdo;
import org.eclipse.emf.cdo.common.id.CDOID;
import org.eclipse.emf.cdo.common.id.CDOIDTemp;
import org.eclipse.emf.cdo.common.id.CDOWithID;
import org.eclipse.emf.cdo.common.revision.CDORevision;
import org.eclipse.emf.cdo.common.revision.CDORevisionManager;
import org.eclipse.emf.cdo.eresource.CDOResource;
import org.eclipse.emf.cdo.view.CDOView;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.resource.Resource;
import org.eclipse.emf.spi.cdo.InternalCDOObject;
/**
* A specialized subinterface of {@link EObject} that is exposed by all CDO objects and allows access to special CDO
* properties and features of those objects.
* <p>
* Note that, by contract, every instance of CDOObject can also be cast to {@link InternalCDOObject}.
*
* @author Eike Stepper
*/
public interface CDOObject extends EObject, CDOWithID
{
/**
* Returns the <em>technical</em> object identifier of this object, or <code>null</code> if the {@link #cdoState()
* state} of this object is {@link CDOState#TRANSIENT TRANSIENT} or {@link CDOState#INVALID INVALID}.
* <p>
* If the state of this object is {@link CDOState#NEW NEW} the returned CDOID instance can be cast to
* {@link CDOIDTemp} and is unique in the scope of the associated {@link #cdoView() transaction}. In all other states
* a non-<code>null</code> return value uniquely identifies a persistent object in the scope of the whole repository.
*
* @see #cdoState()
*/
public CDOID cdoID();
/**
* Returns the local {@link CDOState state} of this object.
*/
public CDOState cdoState();
/**
* Returns <code>true</code> if this object contains local changes that are conflicting with recognized remote
* changes, <code>false</code> otherwise.
* <p>
* This method is a convenience method to determine whether the {@link #cdoState() state} of this object is either
* {@link CDOState#CONFLICT CONFLICT} or {@link CDOState#INVALID_CONFLICT INVALID_CONFLICT}.
*
* @since 2.0
*/
public boolean cdoConflict();
/**
* Returns <code>true</code> if this object is considered as locally invalid (TODO Simon: please briefly explain what
* this state means) , <code>false</code> otherwise.
* <p>
* This method is a convenience method to determine whether the {@link #cdoState() state} of this object is either
* {@link CDOState#INVALID INVALID} or {@link CDOState#INVALID_CONFLICT INVALID_CONFLICT}.
*
* @since 2.0
*/
public boolean cdoInvalid();
/**
* Returns the {@link CDOView view} this object is associated with, or <code>null</code> if this object is not
* associated with a view. This view manages all aspects of this object and cahces it as long as required.
*
* @since 2.0
*/
public CDOView cdoView();
/**
* Returns the {@link CDORevision revision} of this object, or <code>null</code> if this object does currently not
* have a revision. The revision is used to store all modeled data of this object, together with some technical data
* required by the framework.
*/
public CDORevision cdoRevision();
/**
* Returns the {@link CDOResource resource} of this object, no matter where this object is located in the containment
* tree of that resource, or <code>null</code> if this object is not contained in a CDO resource.
* <p>
* This method may not return <code>null</code> return for objects that have no {@link #cdoDirectResource() direct
* resource}. Please note that, depending on the containment depth of this object, the evaluation of the resource can
* be a costly operation.
*
* @see #cdoDirectResource()
*/
public CDOResource cdoResource();
/**
* Returns the directly containing {@link CDOResource resource} of this object, or <code>null</code> if this object is
* not an element of the {@link Resource#getContents() contents} list of any CDO resource.
* <p>
* Please note that, independend of the containment depth of this object, the evaluation of the direct resource is an
* operation with a constant cost.
*
* @since 2.0
*/
public CDOResource cdoDirectResource();
/**
* Returns the read lock associated with this object.
*
* @return Never <code>null</code>.
* @since 2.0
*/
public CDOLock cdoReadLock();
/**
* Returns the write lock associated with this object.
*
* @return Never <code>null</code>.
* @since 2.0
*/
public CDOLock cdoWriteLock();
/**
* @since 4.1
*/
public CDOLock cdoWriteOption();
/**
* Ensures that the revisions of the contained objects up to the given depth are in the local
* {@link CDORevisionManager revision cache}. Subsequent access to the respective contained objects will not lead to
* server round-trips after calling this method.
*
* @param depth
* {@link CDORevision#DEPTH_NONE}, {@link CDORevision#DEPTH_INFINITE} or any other positive integer number.
* @since 3.0
*/
public void cdoPrefetch(int depth);
/**
* TODO: JavaDoc
*/
public void cdoReload();
}
|
