/*
 * Copyright (C) 2005 - 2011 Jaspersoft Corporation. All rights reserved.
 * http://www.jaspersoft.com.
 *
 * Unless you have purchased  a commercial license agreement from Jaspersoft,
 * the following license terms  apply:
 *
 * This program is free software: you can redistribute it and/or  modify
 * it under the terms of the GNU Affero General Public License  as
 * published by the Free Software Foundation, either version 3 of  the
 * License, or (at your option) any later version.
 *
 * This program 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 Affero  General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public  License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

package com.jaspersoft.jasperserver.war.cascade.token;

import java.util.Map;

import com.jaspersoft.jasperserver.api.metadata.jasperreports.domain.ReportDataSource;

/**
 * @author bob
 *
 */
public interface FilterResolver {

	/**
	 * does the query have params?
	 * @param queryString
	 * @param parameters TODO
	 * @return
	 */
	boolean hasParameters(String queryString, Map parameters);

	/**
	 * return string with parameters substituted for displayable values.
	 * Update given parameters with LoggedInUser values as requested
	 * 
	 * @param queryString
	 * @param providedParameters
	 * @return map of params used to resolve query
	 */
	Map resolveParameters(String queryString, Map providedParameters);

	/**
	 * Get a key to use for caching the query results 
	 * @param rawQueryString
	 * @param parameterValues
	 * @return
	 */
	Object getCacheKey(String rawQueryString, Map parameterValues);

	/**
	 * This tells TokenControlLogic that we need the ReportDataSourceService.setReportParameterValues() 
	 * run before we can look at parameters. This is only required for domain data sources.
	 * @param dataSource 
	 * @return true to call setReportParameterValues() before calling any other methods
	 */
	boolean paramTestNeedsDataSourceInit(ReportDataSource dataSource);

}