// Copyright (C) 2011 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.reviewdb.server;

import com.google.gerrit.reviewdb.client.Branch;
import com.google.gerrit.reviewdb.client.Project;
import com.google.gerrit.reviewdb.client.SubmoduleSubscription;
import com.google.gwtorm.server.Access;
import com.google.gwtorm.server.OrmException;
import com.google.gwtorm.server.PrimaryKey;
import com.google.gwtorm.server.Query;
import com.google.gwtorm.server.ResultSet;

public interface SubmoduleSubscriptionAccess extends
    Access<SubmoduleSubscription, SubmoduleSubscription.Key> {
  @PrimaryKey("key")
  SubmoduleSubscription get(SubmoduleSubscription.Key key) throws OrmException;

  @Query("WHERE key.superProject = ?")
  ResultSet<SubmoduleSubscription> bySuperProject(Branch.NameKey superProject)
      throws OrmException;

  /**
   * Fetches all <code>SubmoduleSubscription</code>s in which some branch of
   * <code>superProject</code> subscribes a branch.
   *
   * Use {@link #bySuperproject(Branch.NameKey)} to fetch for a branch instead
   * of a project.
   *
   * @param superProject the project to fetch subscriptions for
   * @return <code>SubmoduleSubscription</code>s that are subscribed by some
   * branch of <code>superProject</code>.
   * @throws OrmException
   */
  @Query("WHERE key.superProject.projectName = ?")
  ResultSet<SubmoduleSubscription> bySuperProjectProject(Project.NameKey superProject)
      throws OrmException;

  @Query("WHERE submodule = ?")
  ResultSet<SubmoduleSubscription> bySubmodule(Branch.NameKey submodule)
      throws OrmException;

  /**
   * Fetches all <code>SubmoduleSubscription</code>s in which some branch of
   * <code>submodule</code> is subscribed.
   *
   * Use {@link #bySubmodule(Branch.NameKey)} to fetch for a branch instead of
   * a project.
   *
   * @param submodule the project to fetch subscriptions for.
   * @return <code>SubmoduleSubscription</code>s that subscribe some branch of
   * <code>submodule</code>.
   * @throws OrmException
   */
  @Query("WHERE submodule.projectName = ?")
  ResultSet<SubmoduleSubscription> bySubmoduleProject(Project.NameKey submodule)
      throws OrmException;
}