offapi/com/sun/star/task/XAsyncJob.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: XAsyncJob.idl,v $
  10  * $Revision: 1.8 $
  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_XAsyncJob_idl__
  32 #define __com_sun_star_task_XAsyncJob_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_beans_NamedValue_idl__
  39 #include <com/sun/star/beans/NamedValue.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  43 #include <com/sun/star/lang/IllegalArgumentException.idl>
  44 #endif
  45
  46 //=============================================================================
  47
  48 module com {  module sun {  module star {  module task {
  49
  50  published interface XJobListener;
  51
  52 //=============================================================================
  53 /** specifies a job which must be executed asynchronously
  54
  55     <p>
  56     Instead of <type>XJob</type> the implementation of this interface
  57     must be aware, that execution can be made real asynchronous (e.g. by using
  58     threads). Because the environment whish to have creation and using of threads
  59     under control, it's not allowed for a real job implementation to use such mechanism
  60     by itself. The outside code decide, if it's possible and how it can be made
  61     asynchronous. In some special cases it can be, that asynchronous jobs will be executed
  62     synchronously.
  63     </p>
  64
  65     @see XJob
  66 */
  67 published interface XAsyncJob : com::sun::star::uno::XInterface
  68 {
  69     //------------------------------------------------------------------------
  70     /** executes the job asynchronously
  71
  72         @param Arguments
  73             are arguments for executing the job. Their semantics is completely implementation dependent. Usually,
  74             a concrete implementation of a job specifies in its service descriptions which parameters are allowed
  75             (or expected). This values are persistent by the configuration of the <type>JobExecutor</type>
  76             which use this asynchronous job. It's possible to write it back by called listener
  77             function <member>XJobListener::jobFinished()</member>.
  78
  79         @param Listener
  80             specifies a listener which should be notified on events. May be <NULL/>.
  81
  82         @throws com::sun::star::lang::IllegalArgumentException
  83             if some of given arguments doesn't fill out the service specification or
  84             was corrupt so the service couldn't work correctly
  85     */
  86    void executeAsync(
  87         [in] sequence< com::sun::star::beans::NamedValue > Arguments,
  88         [in] XJobListener Listener)
  89             raises( com::sun::star::lang::IllegalArgumentException );
  90 };
  91
  92 }; }; }; };
  93
  94 #endif
  95