1 /************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23 package com.sun.star.report; 24 25 /** 26 * The report job is created by the report job factory and holds all properties 27 * required to complete the reporting task. 28 * 29 * @author Thomas Morgner 30 */ 31 public interface ReportJobDefinition 32 { 33 34 /** 35 * The parameters of the root report definition. The report parameters are using 36 * by the query factory to parametrize the query statement. 37 * 38 * The query parameters for the subreports are defined using mappings, it would not 39 * make sense to define them here. 40 * 41 * @return a map containing the report parameters 42 */ getQueryParameters()43 ParameterMap getQueryParameters(); 44 45 /** 46 * The report processing parameters control the behaviour of the report. There are 47 * several mandatory parameters, some optional and possibly some not-yet-understood 48 * parameters. Use the engine meta data to find out, which parameters are supported. 49 * 50 * @return the processing parameters 51 */ getProcessingParameters()52 JobProperties getProcessingParameters(); 53 } 54