1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski  *
3*b1cdbd2cSJim Jagielski  * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski  * or more contributor license agreements.  See the NOTICE file
5*b1cdbd2cSJim Jagielski  * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski  * regarding copyright ownership.  The ASF licenses this file
7*b1cdbd2cSJim Jagielski  * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski  * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski  * with the License.  You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski  *
11*b1cdbd2cSJim Jagielski  *   http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski  *
13*b1cdbd2cSJim Jagielski  * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski  * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski  * KIND, either express or implied.  See the License for the
17*b1cdbd2cSJim Jagielski  * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski  * under the License.
19*b1cdbd2cSJim Jagielski  *
20*b1cdbd2cSJim Jagielski  *************************************************************/
21*b1cdbd2cSJim Jagielski 
22*b1cdbd2cSJim Jagielski 
23*b1cdbd2cSJim Jagielski package com.sun.star.report;
24*b1cdbd2cSJim Jagielski 
25*b1cdbd2cSJim Jagielski /**
26*b1cdbd2cSJim Jagielski  * The job factory collects all required properties to build a reportJob
27*b1cdbd2cSJim Jagielski  * object. Implementors should define a suitable set of properties to allow
28*b1cdbd2cSJim Jagielski  * the configuration of the created report jobs.
29*b1cdbd2cSJim Jagielski  *
30*b1cdbd2cSJim Jagielski  * How these properties are collected is beyond the scope of this interface.
31*b1cdbd2cSJim Jagielski  * For each type of Job, there should be separate job-factory (remote jobs
32*b1cdbd2cSJim Jagielski  * vs. local jobs etc).
33*b1cdbd2cSJim Jagielski  *
34*b1cdbd2cSJim Jagielski  * @author Thomas Morgner
35*b1cdbd2cSJim Jagielski  */
36*b1cdbd2cSJim Jagielski public interface ReportEngine
37*b1cdbd2cSJim Jagielski {
38*b1cdbd2cSJim Jagielski 
createJobDefinition()39*b1cdbd2cSJim Jagielski     public ReportJobDefinition createJobDefinition();
40*b1cdbd2cSJim Jagielski 
getMetaData()41*b1cdbd2cSJim Jagielski     public ReportEngineMetaData getMetaData();
42*b1cdbd2cSJim Jagielski 
43*b1cdbd2cSJim Jagielski     /**
44*b1cdbd2cSJim Jagielski      * Open points: How to define scheduling?
45*b1cdbd2cSJim Jagielski      *
46*b1cdbd2cSJim Jagielski      * @param definition
47*b1cdbd2cSJim Jagielski      * @return the report job definition for the job description.
48*b1cdbd2cSJim Jagielski      * @throws JobDefinitionException
49*b1cdbd2cSJim Jagielski      */
createJob(ReportJobDefinition definition)50*b1cdbd2cSJim Jagielski     public ReportJob createJob(ReportJobDefinition definition)
51*b1cdbd2cSJim Jagielski             throws JobDefinitionException;
52*b1cdbd2cSJim Jagielski }
53