#8127 Added setBuffered and isBuffered to com.vaadin.data.Buffered

1 files changed, 38 insertions, 0 deletions

diff --git a/src/com/vaadin/data/Buffered.java b/src/com/vaadin/data/Buffered.java
index 7fc552f5d6..6498ca519d 100644
--- a/src/com/vaadin/data/Buffered.java
+++ b/src/com/vaadin/data/Buffered.java
@@ -131,6 +131,44 @@ public interface Buffered extends Serializable {
     public void setReadThrough(boolean readThrough) throws SourceException;
 
     /**
+     * Sets the object's buffered mode to the specified status.
+     * <p>
+     * When the object is in buffered mode, an internal buffer will be used to
+     * store changes until {@link #commit()} is called. Calling
+     * {@link #discard()} will revert the internal buffer to the value of the
+     * data source.
+     * </p>
+     * <p>
+     * This is an easier way to use {@link #setReadThrough(boolean)} and
+     * {@link #setWriteThrough(boolean)} and not as error prone. Changing
+     * buffered mode will change both the read through and write through state
+     * of the object.
+     * </p>
+     * <p>
+     * Mixing calls to {@link #setBuffered(boolean)}/{@link #isBuffered()} and
+     * {@link #setReadThrough(boolean)}/{@link #isReadThrough()} or
+     * {@link #setWriteThrough(boolean)}/{@link #isWriteThrough()} is generally
+     * a bad idea.
+     * </p>
+     * 
+     * @param buffered
+     *            true if buffered mode should be turned on, false otherwise
+     * @since 7.0
+     */
+    public void setBuffered(boolean buffered);
+
+    /**
+     * Checks the buffered mode of this Object.
+     * <p>
+     * This method only returns true if both read and write buffering is used.
+     * </p>
+     * 
+     * @return true if buffered mode is on, false otherwise
+     * @since 7.0
+     */
+    public boolean isBuffered();
+
+    /**
      * Tests if the value stored in the object has been modified since it was
      * last updated from the data source.
      *