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 job factory collects all required properties to build a reportJob
27  * object. Implementors should define a suitable set of properties to allow
28  * the configuration of the created report jobs.
29  *
30  * How these properties are collected is beyond the scope of this interface.
31  * For each type of Job, there should be separate job-factory (remote jobs
32  * vs. local jobs etc).
33  *
34  * @author Thomas Morgner
35  */
36 public interface ReportEngine
37 {
38 
createJobDefinition()39     public ReportJobDefinition createJobDefinition();
40 
getMetaData()41     public ReportEngineMetaData getMetaData();
42 
43     /**
44      * Open points: How to define scheduling?
45      *
46      * @param definition
47      * @return the report job definition for the job description.
48      * @throws JobDefinitionException
49      */
createJob(ReportJobDefinition definition)50     public ReportJob createJob(ReportJobDefinition definition)
51             throws JobDefinitionException;
52 }
53