net.sf.jasperreports.web.servlets.JasperPrintAccessor Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jasperreports Show documentation
Show all versions of jasperreports Show documentation
Free Java Reporting Library
/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 2019 TIBCO Software Inc. 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 part of JasperReports.
*
* JasperReports is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* JasperReports 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with JasperReports. If not, see .
*/
package net.sf.jasperreports.web.servlets;
import net.sf.jasperreports.engine.JasperPrint;
/**
* {@link JasperPrint} accessor object.
*
* Such an object is usually placed on the session when a report is generated.
*
* @author Lucian Chirita ([email protected])
*/
public interface JasperPrintAccessor
{
/**
* Ensures that a page is available in the generated report.
*
* @param pageIdx the page index
* @param pageTimestamp
* @return the status of the requested page
*/
ReportPageStatus pageStatus(int pageIdx, Long pageTimestamp);
/**
* Returns the generated report.
*
* @return the generated report
*/
JasperPrint getJasperPrint();
/**
* Returns the generated report, ensuring before that the report generation has ended.
*
* @return the final generated report
*/
JasperPrint getFinalJasperPrint();
/**
* Returns the status of the report execution.
*
* @return the status of the report execution
*/
ReportExecutionStatus getReportStatus();
}