reportbuilder/java/com/sun/star/report/ReportEngine.java

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