runtypeformbean.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.servlet.formbean;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import net.sf.irunninglog.canonical.RunType;
import net.sf.irunninglog.util.DTO;

/**
 * Form bean representation of the <em>Run Type</em> business object.  Used to
 * provide an implementation of the <em>Run Type</em> object within the
 * application's view tier.
 *
 * @author <a href="mailto:[e-mail]">Allan Lewis</a>
 * @version $Revision: 1.1.1.1 $ $Date: 2005/06/23 01:49:02 $
 * @since iRunningLog 1.0
 */
public final class RunTypeFormBean extends ReferenceDataFormBean {

    /** <code>Log</code> instance for this class. */
    private static final Log LOG = LogFactory.getLog(RunTypeFormBean.class);

    /**
     * Create a new form bean.
     */
    public RunTypeFormBean() {
        super();
    }

    /**
     * Retrieve the form bean's values.
     *
     * @return A transfer object representing the for bean's state
     */
    public DTO getValues() {
        DTO valueObject = super.getValues();

        if (LOG.isDebugEnabled()) {
            LOG.debug("getValues: Contents of the value object "
                      + " (before) " + valueObject);
        }

        valueObject.setCanonicalId(RunType.CANONICAL_ID);

        if (LOG.isDebugEnabled()) {
            LOG.debug("getValues: Contents of the value object "
                      + " (after) " + valueObject);
        }

        return valueObject;
    }

    /**
     * Update the form bean's values.
     *
     * @param valueObject Value object containing the new values
     *                    to be applied to the form bean
     */
    public void setValues(DTO valueObject) {
        if (LOG.isDebugEnabled()) {
            LOG.debug("setValues: Contents of the value object "
                      + valueObject);
        }

        super.setValues(valueObject);
    }

}