DatabaseReportDescription.java

/*******************************************************************************
 * This file is part of OpenNMS(R).
 *
 * Copyright (C) 2009-2011 The OpenNMS Group, Inc.
 * OpenNMS(R) is Copyright (C) 1999-2011 The OpenNMS Group, Inc.
 *
 * OpenNMS(R) is a registered trademark of The OpenNMS Group, Inc.
 *
 * OpenNMS(R) is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published
 * by the Free Software Foundation, either version 3 of the License,
 * or (at your option) any later version.
 *
 * OpenNMS(R) is distributed in the hope that it 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 for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with OpenNMS(R).  If not, see:
 *      http://www.gnu.org/licenses/
 *
 * For more information contact:
 *     OpenNMS(R) Licensing <license@opennms.org>
 *     http://www.opennms.org/
 *     http://www.opennms.com/
 *******************************************************************************/

package org.opennms.web.svclayer.support;

/**
 * <p>DatabaseReportDescription class.</p>
 *
 * @author ranger
 * @version $Id: $
 * @since 1.8.1
 */
public class DatabaseReportDescription {

    /**
     * Id of a report template
     */
    private String m_id;

    /**
     * Id of the repository
     */
    private String m_repositoryId;

    /**
     * Display name for a report template
     */
    private String m_displayName;

    /**
     * Description for a report template
     */
    private String m_description;

    /**
     * Defines if a report is allowed to be accessed by report repository.
     */
    private boolean m_allowAccess;

    /**
     * Configuration as online report
     */
    private boolean m_isOnline;
    
    /**
     * <p>getId</p>
     *
     * @return a {@link java.lang.String} object.
     */
    public String getId() {
        return m_id;
    }
    /**
     * <p>setId</p>
     *
     * @param id a {@link java.lang.String} object.
     */
    public void setId(String id) {
        m_id = id;
    }
    /**
     * <p>getRepositoryId</p>
     *
     * @return a {@link java.lang.String} object.
     */
    public String getRepositoryId() {
        return m_repositoryId;
    }
    /**
     * <p>setId</p>
     *
     * @param repositoryId a {@link java.lang.String} object.
     */
    public void setRepositoryId(String repositoryId) {
        m_repositoryId = repositoryId;
    }
    /**
     * <p>getDisplayName</p>
     *
     * @return a {@link java.lang.String} object.
     */
    public String getDisplayName() {
        return m_displayName;
    }
    /**
     * <p>setDisplayName</p>
     *
     * @param displayName a {@link java.lang.String} object.
     */
    public void setDisplayName(String displayName) {
        m_displayName = displayName;
    }
    /**
     * <p>getDescription</p>
     *
     * @return a {@link java.lang.String} object.
     */
    public String getDescription() {
        return m_description;
    }
    /**
     * <p>setDescription</p>
     *
     * @param description a {@link java.lang.String} object.
     */
    public void setDescription(String description) {
        m_description = description;
    }

    /**
     * <p>setIsOnline</p>
     * Set isOnline property to define if a report can be executed instantly from the WebUI.
     *  
     * @param isOnline a {@link boolean} object.
     */
    public void setIsOnline(boolean isOnline) {
        m_isOnline = isOnline;
    }

    /**
     * <p>getIsOnline</p>
     * Get isOnline property for instant report execution.
     * 
     * @return a {@link boolean} object.
     */
    public boolean getIsOnline() {
        return m_isOnline;
    }

    /**
     * <p>setAllowAccess</p>
     * Set allowAccess for report execution permission. 
     * 
     * @param allowAccess a {@link boolean} object.
     */
    public void setAllowAccess(boolean allowAccess) {
        m_allowAccess = allowAccess;
    }

    /**
     * <p>getAllowAccess</p>
     * Get allowAccess for report execution permission.
     * 
     * @return a {@link boolean} object
     */
    public boolean getAllowAccess() {
        return m_allowAccess;
    }
}