/*
 * Copyright 2011 Meyer Kizner
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.prealpha.xylophone.shared;

import com.google.gwt.user.client.rpc.IsSerializable;

/**
 * The parent interface for objects which serve as results of an {@link Action}.
 * Though each action class must map to a specific result type, the reverse need
 * not be true; a single result type might have multiple corresponding action
 * classes. Arbitrary objects cannot be allowed as action results; otherwise,
 * GWT RPC would attempt to compile many unnecessary classes into the JavaScript
 * output, including classes which are unserializable.
 * <p>
 * 
 * Note that implementations of this interface must meet the requirements for
 * RPC-serializable objects. In particular, implementation classes must declare
 * a default constructor of any visibility, and they must be designed with the
 * knowledge that final fields will not be serialized.
 * 
 * @author Meyer Kizner
 * 
 */
public interface Result extends IsSerializable {
}

@@ -1153,16 +1153,392 @@
 %3Cp%3E%0A * %0A
+ * A %7B@code Result%7D object may represent a partial or complete result for the%0A * action. A partial result means that the action is not yet complete, but that%0A * the client should be aware of some progress. Clients can elect, through the%0A * %7B@link Dispatcher%7D, to only accept complete results and discard any partial%0A * results created during the execution process.%0A * %3Cp%3E%0A * %0A
  * Note 
@@ -1906,10 +1906,366 @@
 zable %7B%0A
+%09/**%0A%09 * Indicates whether or not this result indicates the completion of an%0A%09 * action. Actions and action handlers may return any number of partial%0A%09 * results, and the dispatcher will continue execution until a complete%0A%09 * result is obtained.%0A%09 * %0A%09 * @return %7B@code true%7D if the result is complete; %7B@code false%7D otherwise%0A%09 */%0A%09boolean isComplete();%0A
 %7D%0A

Add a new method to Result to support partial results (breaks compatibility)