icrudservice.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 net.sf.irunninglog.util.DTO;

/**
 * Business interface to be implemented by any services that provide CRUD
 * (create, read, update, delete) functionality.  This interface provides the
 * four method definitions that implementing classes must provide.
 *
 * @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 ICRUDService 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.ICRUDService";

    /**
     * Create a new business object.
     *
     * @param valueObject Transfer object containing values for
     *                    use in creating the new object
     * @return Transfer object containing the newly created
     *         object's values
     * @throws ServiceException If an unrecoverable error is encountered while
     *                          executing the service
     */
    DTO create(DTO valueObject) throws ServiceException;

    /**
     * Read (select) a business object's values.
     *
     * @param valueObject Transfer object containing information used
     *                    to find the object whose values are to be read
     * @return Transfer object containing the values read from the object
     * @throws ServiceException If an unrecoverable error is encountered while
     *                          executing the service
     */
    DTO read(DTO valueObject) throws ServiceException;

    /**
     * Update a business object's values.
     *
     * @param valueObject Transfer object containing values used to
     *                    find and update an object
     * @return Transfer object containing the updated object's values
     * @throws ServiceException If an unrecoverable error is encountered while
     *                          executing the service
     */
    DTO update(DTO valueObject) throws ServiceException;

    /**
     * Delete a business object.
     *
     * @param valueObject Transfer object containing values used to find the
     *                    object to delete
     * @return Transfer object containing the deleted object's values
     * @throws ServiceException If an unrecoverable error is encountered while
     *                          executing the service
     */
    DTO delete(DTO valueObject) throws ServiceException;

}