reportbuilder/java/org/libreoffice/report/ReportJobDefinition.java

   1 /*
   2  * This file is part of the LibreOffice project.
   3  *
   4  * This Source Code Form is subject to the terms of the Mozilla Public
   5  * License, v. 2.0. If a copy of the MPL was not distributed with this
   6  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   7  *
   8  * This file incorporates work covered by the following license notice:
   9  *
  10  *   Licensed to the Apache Software Foundation (ASF) under one or more
  11  *   contributor license agreements. See the NOTICE file distributed
  12  *   with this work for additional information regarding copyright
  13  *   ownership. The ASF licenses this file to you under the Apache
  14  *   License, Version 2.0 (the "License"); you may not use this file
  15  *   except in compliance with the License. You may obtain a copy of
  16  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  17  */
  18 package org.libreoffice.report;
  19
  20 /**
  21  * The report job is created by the report job factory and holds all properties
  22  * required to complete the reporting task.
  23  *
  24  */
  25 public interface ReportJobDefinition
  26 {
  27
  28     /**
  29      * The parameters of the root report definition. The report parameters are using
  30      * by the query factory to parametrize the query statement.
  31      *
  32      * The query parameters for the subreports are defined using mappings, it would not
  33      * make sense to define them here.
  34      *
  35      * @return a map containing the report parameters
  36      */
  37     ParameterMap getQueryParameters();
  38
  39     /**
  40      * The report processing parameters control the behaviour of the report. There are
  41      * several mandatory parameters, some optional and possibly some not-yet-understood
  42      * parameters. Use the engine meta data to find out, which parameters are supported.
  43      *
  44      * @return the processing parameters
  45      */
  46     JobProperties getProcessingParameters();
  47 }