233490: Change Subscription

https://bugs.eclipse.org/bugs/show_bug.cgi?id=233490

JAVADOC

2 files changed, 30 insertions, 0 deletions

diff --git a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/CDOSession.java b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/CDOSession.java
index f9b1ca291b..496d22db1e 100644
--- a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/CDOSession.java
+++ b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/CDOSession.java
@@ -66,10 +66,30 @@ public interface CDOSession extends CDOProtocolSession, IContainer<CDOView>
 
   public CDOAudit openAudit(long timeStamp);
   
+  /**
+   * Specifies whether object will be invalidate from others users changes. 
+   * <p>
+   * By default this value is enabled.
+   * <p>
+   * If you disabled this property, you can still have the latest version of objects by calling refresh
+   * <p>
+   * You would disabled it, in the case where you need performance and/or want to control when objects will be 
+   * refreshed.
+   * <p>
+   * When we activate it, it will perform a refresh to be in sync with the server. 
+   */
   public void setPassiveUpdateEnabled(boolean enable);
   
   public boolean isPassiveUpdateEnabled();
   
+  /**
+   * Refresh objects cache. 
+   * <p>
+   * Take CDOID and version of all objects in the cache, sent it to the server. 
+   * It will return only dirty objects.
+   * <p>
+   * In the case where <code>isPassiveUpdateEnabled<code> is true, it will return immediately without doing anything.
+   */
   public Set<CDOID> refresh();
 
   public void close();
diff --git a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/CDOView.java b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/CDOView.java
index 2fbcec0f1a..2722b68919 100644
--- a/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/CDOView.java
+++ b/plugins/org.eclipse.emf.cdo/src/org/eclipse/emf/cdo/CDOView.java
@@ -64,6 +64,16 @@ public interface CDOView extends CDOProtocolView, INotifier
 
   public CDOChangeSubscriptionPolicy getChangeSubscriptionPolicy();
 
+  /**
+   * Specifies the change subscription policy. By default, the value is set to {@link CDOChangeSubscriptionPolicy.NONE}.
+   * <p>
+   * By activating this feature, every objects that have at least one adapter that match the current policy will be
+   * registered to the server and will be notify for every changes happening on any other CDOTransaction.
+   * <p>
+   * {@link CDOChangeSubscriptionPolicy.NONE} - Disabled
+   * {@link CDOChangeSubscriptionPolicy.ALL} - Enabled
+   * Any others classes that implement {@link CDOChangeSubscriptionPolicy} - Enabled   
+   */
   public void setChangeSubscriptionPolicy(CDOChangeSubscriptionPolicy changeSubscriptionPolicy);
 
   public int getLoadRevisionCollectionChunkSize();