offapi/com/sun/star/task/Job.idl

   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
  28 #ifndef __com_sun_star_task_Job_idl__
  29 #define __com_sun_star_task_Job_idl__
  30
  31 #ifndef __com_sun_star_task_XJob_idl__
  32 #include <com/sun/star/task/XJob.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_util_XCloseable_idl__
  36 #include <com/sun/star/util/XCloseable.idl>
  37 #endif
  38
  39 //============================================================================
  40
  41 module com { module sun { module star { module task {
  42
  43 //============================================================================
  44 /** represent a synchronous job, which can be executed by the global <type>JobExecutor</type>
  45     instance.
  46
  47     @see AsyncJob
  48
  49     @since OOo 1.1.2
  50  */
  51 published service Job
  52 {
  53     //------------------------------------------------------------------------
  54     /** used to initialize and execute this job.
  55      */
  56     interface com::sun::star::task::XJob;
  57
  58     //------------------------------------------------------------------------
  59     /** should be supported to handle environment termination gracefully.
  60      */
  61     [optional] interface com::sun::star::util::XCloseable;
  62 };
  63
  64 }; }; }; };
  65
  66 #endif