ServiceAsync.java

/* Copyright (c) 2009 Google Inc.
 *
 * 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.google.appengine.demos.sticky.client.model;

import java.util.Date;

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

/**
 * The asynchronous interface for calls to {@link Service}.
 * 
 * @author knorton@google.com (Kelly Norton)
 * 
 */
public interface ServiceAsync {

  /**
   * @see Service#addAuthorToSurface(String, String)
   * @param surfaceKey
   * @param email
   * @param callback
   */
  void addAuthorToSurface(String surfaceKey, String email,
      AsyncCallback<Service.AddAuthorToSurfaceResult> callback);

  /**
   * @see Service#changeNoteContent(String, String)
   * @param noteKey
   * @param content
   * @param callback
   */
  void changeNoteContent(String noteKey, String content,
      AsyncCallback<Date> callback);

  /**
   * @see Service#changeNotePosition(String, int, int, int, int)
   * @param noteKey
   * @param x
   * @param y
   * @param width
   * @param height
   * @param callback
   */
  void changeNotePosition(String noteKey, int x, int y, int width, int height,
      AsyncCallback<Date> callback);

  /**
   * @see Service#createNote(String, int, int, int, int)
   * @param surfaceKey
   * @param x
   * @param y
   * @param width
   * @param height
   * @param callback
   */
  void createNote(String surfaceKey, int x, int y, int width, int height,
      AsyncCallback<Service.CreateObjectResult> callback);

  /**
   * @see Service#createSurface(String)
   * @param title
   * @param callback
   */
  void createSurface(String title,
      AsyncCallback<Service.CreateObjectResult> callback);

  /**
   * @see Service#getNotes(String, String)
   * @param surfaceKey
   * @param timestamp
   * @param callback
   */
  void getNotes(String surfaceKey, String timestamp,
      AsyncCallback<Service.GetNotesResult> callback);

  /**
   * @see Service#getSurfaces(String)
   * @param timestamp
   * @param callback
   */
  void getSurfaces(String timestamp,
      AsyncCallback<Service.GetSurfacesResult> callback);

  /**
   * @see Service#getUserInfo()
   * @param callback
   */
  void getUserInfo(AsyncCallback<Service.UserInfoResult> callback);
}