ReportServiceLocator.java

/*******************************************************************************
 * This file is part of OpenNMS(R).
 *
 * Copyright (C) 2010-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.reporting.core.svclayer;

import org.opennms.api.reporting.ReportService;

/**
 * This class provides a simple mechanism for returning the ReportService bean
 * for a given reportId
 *
 * @author <a href="mailto:jonathan@opennms.org">Jonathan Sartin</a>
 */
public interface ReportServiceLocator  {
    
    /**
     * This method is used to retrieve the ReportService bean associated with
     *
     * @param   reportServiceName the name of the report service as
     *          as defined in database-reports.xml
     * @return  the ReportService bean used to run this report
     * @throws  org.opennms.reporting.core.svclayer.ReportServiceLocatorException if any.
     */
    public ReportService getReportService(String reportServiceName) throws ReportServiceLocatorException; 
    
    /**
     * This method is used to retrieve the ReportService bean associated with a report Id
     *
     * @param   reportId the reportID defined in database-reports.xml
     * @return  the ReportService bean used to run this report
     * @throws  org.opennms.reporting.core.svclayer.ReportServiceLocatorException if any.
     */
    public ReportService getReportServiceForId(String reportId) throws ReportServiceLocatorException; 

}