iqueryservice.java

A Java web application, based on Struts and Hibernate, that serves as an online running log. Users m

/* @LICENSE_COPYRIGHT@ */
package net.sf.irunninglog.service;

import java.util.Collection;

/**
 * Business interface to be implemented by any service that provides query
 * functionality.  This class defines the methods for all of the queries that
 * the application needs to perform.
 *
 * @author <a href="mailto:[e-mail]">Allan Lewis</a>
 * @version $Revision: 1.1.1.1 $ $Date: 2005/06/23 01:48:57 $
 * @since iRunningLog 1.0
 */
public interface IQueryService extends IService {

    /**
     * Unique name for this type of service.  Used by the
     * <code>ServiceFactory</code> to look up implementation classes when
     * creating new services.
     *
     * @see ServiceFactory#newService(String)
     */
    String SERVICE_NAME = "net.sf.irunninglog.service.IQueryService";

    /**
     * Retrieve all of the Shoes associated with a particular Runner.  This
     * will return a <code>Collection</code> of <code>DTO</code>s representing
     * the shoes for the Runner whose <em>id</em> matches the method parameter.
     *
     * @param runnerId The <em>id</em> of the Runner whose shoes are to be
     *                 retrieved
     * @return The <code>Collection</code> of <code>DTO</code>s representing
     *         the Runner's Shoes
     * @throws ServiceException If there is an error while performing the query
     */
    Collection findShoesForRunner(String runnerId) throws ServiceException;

    /**
     * Retrieve all of the Routes associated with a particular Runner.  This
     * will return a <code>Collection</code> of <code>DTO</code>s representing
     * the routes for the Runner whose <em>id</em> matches the method parameter.
     *
     * @param runnerId The <em>id</em> of the Runner whose routes are to be
     *                 retrieved
     * @return The <code>Collection</code> of <code>DTO</code>s representing
     *         the Runner's Routes
     * @throws ServiceException If there is an error while performing the query
     */
    Collection findRoutesForRunner(String runnerId) throws ServiceException;

    /**
     * Retrieve all of the Run Types associated with a particular Runner.  This
     * will return a <code>Collection</code> of <code>DTO</code>s representing
     * the run types for the Runner whose <em>id</em> matches the method
     * parameter.
     *
     * @param runnerId The <em>id</em> of the Runner whose run types are to be
     *                 retrieved
     * @return The <code>Collection</code> of <code>DTO</code>s representing
     *         the Runner's Run Types
     * @throws ServiceException If there is an error while performing the query
     */
    Collection findRunTypesForRunner(String runnerId) throws ServiceException;

    /**
     * Retrieve all of the Run Data associated with a particular runner for a
     * given month/year combination.  This will return a <code>Collection</code>
     * of <code>DTOs</code>s represeting the run data for the Runner whose
     * <em>id</em> matches the method parameter (for the month/year specified).
     *
     * @param runnerId The <em>id</em> of the Runner whose run data is to be
     *                 retrieved
     * @param month The month for which run data should be retrieved
     * @param year The year for which run data should be retrieved
     * @return The <code>Collection</code> of <code>DTO</code>s representing
     *         the Runner's Run Data
     * @throws ServiceException If there is an error while performing the query
     */
    Collection findRunDataForRunnerByMonth(String runnerId, int month, int year)
                                                        throws ServiceException;

}