1 /*************************************************************************
2  *
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * Copyright 2000, 2010 Oracle and/or its affiliates.
6  *
7  * OpenOffice.org - a multi-platform office productivity suite
8  *
9  * This file is part of OpenOffice.org.
10  *
11  * OpenOffice.org is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * OpenOffice.org is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Lesser General Public License version 3 for more details
19  * (a copy is included in the LICENSE file that accompanied this code).
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * version 3 along with OpenOffice.org.  If not, see
23  * <http://www.openoffice.org/license.html>
24  * for a copy of the LGPLv3 License.
25  *
26  ************************************************************************/
27 package com.sun.star.report;
28 
29 /**
30  * The report job is created by the report job factory and holds all properties
31  * required to complete the reporting task.
32  *
33  * @author Thomas Morgner
34  */
35 public interface ReportJobDefinition
36 {
37 
38     /**
39      * The parameters of the root report definition. The report parameters are using
40      * by the query factory to parametrize the query statement.
41      *
42      * The query parameters for the subreports are defined using mappings, it would not
43      * make sense to define them here.
44      *
45      * @return a map containing the report parameters
46      */
47     ParameterMap getQueryParameters();
48 
49     /**
50      * The report processing parameters control the behaviour of the report. There are
51      * several mandatory parameters, some optional and possibly some not-yet-understood
52      * parameters. Use the engine meta data to find out, which parameters are supported.
53      *
54      * @return the processing parameters
55      */
56     JobProperties getProcessingParameters();
57 }
58