FramesListForm.java :  » Groupware » ivatagroupware » com » ivata » groupware » mask » struts » Java Open Source

/*
 * Copyright (c) 2001 - 2005 ivata limited.
 * All rights reserved.
 * -----------------------------------------------------------------------------
 * ivata groupware may be redistributed under the GNU General Public
 * License as published by the Free Software Foundation;
 * version 2 of the License.
 *
 * These programs are free software; you can redistribute them and/or
 * modify them under the terms of the GNU General Public License
 * as published by the Free Software Foundation; version 2 of the License.
 *
 * These programs are distributed in the hope that they will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 *
 * See the GNU General Public License in the file LICENSE.txt for more
 * details.
 *
 * If you would like a copy of the GNU General Public License write to
 *
 * Free Software Foundation, Inc.
 * 59 Temple Place - Suite 330
 * Boston, MA 02111-1307, USA.
 *
 *
 * To arrange commercial support and licensing, contact ivata at
 *                  http://www.ivata.com/contact.jsp
 * -----------------------------------------------------------------------------
 * $Log: FramesListForm.java,v $
 * Revision 1.3  2005/10/03 10:21:14  colinmacleod
 * Fixed some style and javadoc issues.
 *
 * Revision 1.2  2005/10/02 14:08:57  colinmacleod
 * Added/improved log4j logging.
 *
 * Revision 1.1  2005/09/29 14:04:05  colinmacleod
 * Generalized frames model of ivata masks - initially for use in ivata cms.
 *
 */
package com.ivata.groupware.mask.struts;

import org.apache.log4j.Logger;

import java.util.List;

import com.ivata.mask.Mask;
import com.ivata.mask.web.struts.ListForm;
;

/**
 * @since ivata groupware 1.0 (16-Sep-2005)
 * @author Colin MacLeod <colin.macleod@ivata.com>
 * @version $Revision: 1.3 $
 */
public class FramesListForm extends ListForm {
    /**
     * Logger for this class.
     */
    private static final Logger logger = Logger.getLogger(FramesListForm.class);

    /**
     * Serialization version (for <code>Serializable</code> interface).
     */
    private static final long serialVersionUID = 1L;
    private String contentFrameName;
    private String inputMask;
    private String menuFrameName;
    private String menuFrameURI;
    private String selectedId;

    public FramesListForm(List valueObjectsParam, Mask maskParam,
            Class baseClassParam) {
        super(valueObjectsParam, maskParam, baseClassParam);
    }

    /**
     * @return Returns the contentFrameName.
     */
    public String getContentFrameName() {
        if (logger.isDebugEnabled()) {
            logger.debug("getContentFrameName() - start");
        }

        if (logger.isDebugEnabled()) {
            logger.debug("getContentFrameName() - end - return value = "
                    + contentFrameName);
        }
        return contentFrameName;
    }

    /**
     * @return Returns the inputMask.
     */
    public String getInputMask() {
        if (logger.isDebugEnabled()) {
            logger.debug("getInputMask() - start");
        }

        if (logger.isDebugEnabled()) {
            logger.debug("getInputMask() - end - return value = " + inputMask);
        }
        return inputMask;
    }

    /**
     * @return Returns the menuFrameName.
     */
    public String getMenuFrameName() {
        if (logger.isDebugEnabled()) {
            logger.debug("getMenuFrameName() - start");
        }

        if (logger.isDebugEnabled()) {
            logger.debug("getMenuFrameName() - end - return value = "
                    + menuFrameName);
        }
        return menuFrameName;
    }

    /**
     * @return Returns the menuFrameURI.
     */
    public String getMenuFrameURI() {
        if (logger.isDebugEnabled()) {
            logger.debug("getMenuFrameURI() - start");
        }

        if (logger.isDebugEnabled()) {
            logger.debug("getMenuFrameURI() - end - return value = "
                    + menuFrameURI);
        }
        return menuFrameURI;
    }

    /**
     * @return Returns the selectedId.
     */
    public String getSelectedId() {
        if (logger.isDebugEnabled()) {
            logger.debug("getSelectedId() - start");
        }

        if (logger.isDebugEnabled()) {
            logger
                    .debug("getSelectedId() - end - return value = "
                            + selectedId);
        }
        return selectedId;
    }

    /**
     * <copyDoc>Refer to {@link #getcontentFrameName}.</copyDoc>
     * @param contentFrameNameParam <copyDoc>Refer to {@link #getcontentFrameName}.</copyDoc>
     */
    public void setContentFrameName(String contentFrameNameParam) {
        if (logger.isDebugEnabled()) {
            logger.debug("setContentFrameName(String contentFrameNameParam = "
                    + contentFrameNameParam + ") - start");
        }

        contentFrameName = contentFrameNameParam;

        if (logger.isDebugEnabled()) {
            logger.debug("setContentFrameName(String) - end");
        }
    }

    /**
     * <copyDoc>Refer to {@link #getinputMask}.</copyDoc>
     * @param inputMaskParam <copyDoc>Refer to {@link #getinputMask}.</copyDoc>
     */
    public void setInputMask(String inputMaskParam) {
        if (logger.isDebugEnabled()) {
            logger.debug("setInputMask(String inputMaskParam = "
                    + inputMaskParam + ") - start");
        }

        inputMask = inputMaskParam;

        if (logger.isDebugEnabled()) {
            logger.debug("setInputMask(String) - end");
        }
    }

    /**
     * <copyDoc>Refer to {@link #getmenuFrameName}.</copyDoc>
     * @param menuFrameNameParam <copyDoc>Refer to {@link #getmenuFrameName}.</copyDoc>
     */
    public void setMenuFrameName(String menuFrameNameParam) {
        if (logger.isDebugEnabled()) {
            logger.debug("setMenuFrameName(String menuFrameNameParam = "
                    + menuFrameNameParam + ") - start");
        }

        menuFrameName = menuFrameNameParam;

        if (logger.isDebugEnabled()) {
            logger.debug("setMenuFrameName(String) - end");
        }
    }

    /**
     * <copyDoc>Refer to {@link #getmenuFrameURI}.</copyDoc>
     * @param menuFrameURIParam <copyDoc>Refer to {@link #getmenuFrameURI}.</copyDoc>
     */
    public void setMenuFrameURI(String menuFrameURIParam) {
        if (logger.isDebugEnabled()) {
            logger.debug("setMenuFrameURI(String menuFrameURIParam = "
                    + menuFrameURIParam + ") - start");
        }

        menuFrameURI = menuFrameURIParam;

        if (logger.isDebugEnabled()) {
            logger.debug("setMenuFrameURI(String) - end");
        }
    }

    /**
     * <copyDoc>Refer to {@link #getselectedId}.</copyDoc>
     * @param selectedIdParam <copyDoc>Refer to {@link #getselectedId}.</copyDoc>
     */
    public void setSelectedId(String selectedIdParam) {
        if (logger.isDebugEnabled()) {
            logger.debug("setSelectedId(String selectedIdParam = "
                    + selectedIdParam + ") - start");
        }

        selectedId = selectedIdParam;

        if (logger.isDebugEnabled()) {
            logger.debug("setSelectedId(String) - end");
        }
    }

}