/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.wicket.spring.common;

import javax.jws.WebService;
import javax.jws.WebMethod;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import java.util.Iterator;

/**
 * interface for retrieving contacts from a database
 *
 * @author Igor Vaynberg (ivaynberg)
 */
@WebService
public interface ContactDao {
  /**
   * @return total number of contacts available
   */
  int count();

  /**
   * @param qp sorting and paging info
   * @return iterator over contacts
   */
  @WebMethod (
    exclude = true
  )
  Iterator find(QueryParam qp);

  /**
   * @param id contact id
   * @return contact with matching id
   */
  @GET
  @Path("/contact/{id}")
  Contact get(@PathParam( "id" ) long id);
}