net.sf.jasperreports.engine.JRParameter Maven / Gradle / Ivy
/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 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 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
* If set to true the report will be generated on one long page.
*/
public static final String IS_IGNORE_PAGINATION = "IS_IGNORE_PAGINATION";
/**
* A {@link java.util.Collection collection} of {@link JRTemplate templates} passed to the
* report at fill time.
*
* These templates add to the ones specified in the report (see {@link JRReport#getTemplates()}).
* In the final templates list they are placed after the report templates; therefore styles from
* these templates can use and override styles in the report templates.
* They are, however, placed before the report styles hence report styles can use and override
* styles from these templates.
*/
public static final String REPORT_TEMPLATES = "REPORT_TEMPLATES";
/**
*
*/
public static final String SORT_FIELDS = "SORT_FIELDS";
/**
*
*/
public static final String REPORT_CONTEXT = "REPORT_CONTEXT";
/**
* A {@link DatasetFilter} to be used in addition to {@link JRDataset#getFilterExpression()}
* for filtering dataset rows.
*/
public static final String FILTER = "FILTER";
/**
*
*/
public String getName();
/**
*
*/
public String getDescription();
/**
*
*/
public void setDescription(String description);
/**
*
*/
public Class getValueClass();
/**
*
*/
public String getValueClassName();
/**
*
*/
public boolean isSystemDefined();
/**
*
*/
public boolean isForPrompting();
/**
*
*/
public JRExpression getDefaultValueExpression();
/**
* Returns the parameter nested value type.
*
*
* The parameter nested value type is used when the parameter value class
* is not sufficient in determining the expected type of the parameter values.
* The most common such scenario is when the parameter value class is
* {@link java.util.Collection} or a derived class, in which case the nested
* type specifies the type of values which are to be placed inside the collection.
*
* @return the nested value type for this parameter,
* or null if none set
*
* @see #getValueClass()
*/
public Class getNestedType();
/**
* Returns the name of the parameter nested value type.
*
* @return the name of the nested value type for this parameter,
* or null if none set
*
* @see #getNestedType()
*/
public String getNestedTypeName();
}