gerrit-common/src/main/java/com/google/gerrit/common/data/ChangeListService.java

// Copyright (C) 2008 The Android Open Source Project
//
// 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.gerrit.common.data;

import com.google.gerrit.common.auth.SignInRequired;
import com.google.gerrit.reviewdb.Account;
import com.google.gerrit.reviewdb.Change;
import com.google.gerrit.reviewdb.Project;
import com.google.gwt.user.client.rpc.AsyncCallback;
import com.google.gwtjsonrpc.client.RemoteJsonService;
import com.google.gwtjsonrpc.client.RpcImpl;
import com.google.gwtjsonrpc.client.VoidResult;
import com.google.gwtjsonrpc.client.RpcImpl.Version;

import java.util.Set;

@RpcImpl(version = Version.V2_0)
public interface ChangeListService extends RemoteJsonService {
  /** Get all open changes more recent than pos, fetching at most limit rows. */
  void allOpenPrev(String pos, int limit,
      AsyncCallback<SingleListChangeInfo> callback);

  /** Get all open changes older than pos, fetching at most limit rows. */
  void allOpenNext(String pos, int limit,
      AsyncCallback<SingleListChangeInfo> callback);

  /** Get all open changes more recent than pos, fetching at most limit rows. */
  void byProjectOpenPrev(Project.NameKey project, String pos, int limit,
      AsyncCallback<SingleListChangeInfo> callback);

  /** Get all open changes older than pos, fetching at most limit rows. */
  void byProjectOpenNext(Project.NameKey project, String pos, int limit,
      AsyncCallback<SingleListChangeInfo> callback);

  /**
   * Get all closed changes with same status, more recent than pos, fetching at
   * most limit rows.
   */
  void byProjectClosedPrev(Project.NameKey project, Change.Status status,
      String pos, int limit, AsyncCallback<SingleListChangeInfo> callback);

  /**
   * Get all closed changes with same status, older than pos, fetching at most
   * limit rows.
   */
  void byProjectClosedNext(Project.NameKey project, Change.Status status,
      String pos, int limit, AsyncCallback<SingleListChangeInfo> callback);

  /** Get all closed changes more recent than pos, fetching at most limit rows. */
  void allClosedPrev(Change.Status status, String pos, int limit,
      AsyncCallback<SingleListChangeInfo> callback);

  /** Get all closed changes older than pos, fetching at most limit rows. */
  void allClosedNext(Change.Status status, String pos, int limit,
      AsyncCallback<SingleListChangeInfo> callback);

  /** Get all changes which match an arbitrary query string. */
  void allQueryPrev(String query, String pos, int limit,
      AsyncCallback<SingleListChangeInfo> callback);

  /** Get all changes which match an arbitrary query string. */
  void allQueryNext(String query, String pos, int limit,
      AsyncCallback<SingleListChangeInfo> callback);

  /** Get the data to show AccountDashboardScreen for an account. */
  void forAccount(Account.Id id, AsyncCallback<AccountDashboardInfo> callback);

  /** Get the changes starred by the caller. */
  @SignInRequired
  void myStarredChanges(AsyncCallback<SingleListChangeInfo> callback);

  /** Get the changes with unpublished drafts by the caller. */
  @SignInRequired
  void myDraftChanges(AsyncCallback<SingleListChangeInfo> callback);

  /** Get the ids of all changes starred by the caller. */
  @SignInRequired
  void myStarredChangeIds(AsyncCallback<Set<Change.Id>> callback);

  /**
   * Add and/or remove changes from the set of starred changes of the caller.
   *
   * @param req the add and remove cluster.
   */
  @SignInRequired
  void toggleStars(ToggleStarRequest req, AsyncCallback<VoidResult> callback);
}