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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: Job.idl,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_task_Job_idl__
  32 #define __com_sun_star_task_Job_idl__
  33
  34 #ifndef __com_sun_star_task_XJob_idl__
  35 #include <com/sun/star/task/XJob.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_util_XCloseable_idl__
  39 #include <com/sun/star/util/XCloseable.idl>
  40 #endif
  41
  42 //============================================================================
  43
  44 module com { module sun { module star { module task {
  45
  46 //============================================================================
  47 /** represent a synchronous job, which can be executed by the global <type>JobExecutor</type>
  48     instance.
  49
  50     @see AsyncJob
  51
  52     @since OOo 1.1.2
  53  */
  54 published service Job
  55 {
  56     //------------------------------------------------------------------------
  57     /** used to initialize and execute this job.
  58      */
  59     interface com::sun::star::task::XJob;
  60
  61     //------------------------------------------------------------------------
  62     /** should be supported to handle environment termination gracefully.
  63      */
  64     [optional] interface com::sun::star::util::XCloseable;
  65 };
  66
  67 }; }; }; };
  68
  69 #endif