offapi/com/sun/star/task/XJob.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: XJob.idl,v $
  10  * $Revision: 1.9 $
  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_XJob_idl__
  32 #define __com_sun_star_task_XJob_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 //=============================================================================
  51 /** specifies a job which is to be executed synchronously
  52
  53     <p>
  54     Instead of <type>XAsyncJob</type> the implementation of this interface
  55     will be executed synchronously everytimes. That means: they can be shure that the
  56     current stack context will be blocked till this job finish it's work.
  57     </p>
  58
  59     @see XAsyncJob
  60 */
  61 published interface XJob : com::sun::star::uno::XInterface
  62 {
  63     //------------------------------------------------------------------------
  64     /** executes the job synchronously
  65
  66         @param Arguments
  67             are arguments for executing the job. Their semantics is completely implementation dependent. Usually,
  68             a concrete implementation of a job specifies in its service descriptions which parameters are allowed
  69             (or expected). This values are persistent by the configuration of the <type>JobExecutor</type>
  70             which use this synchronous job. It's possible to write it back by use special protocol
  71             in return value.
  72
  73         @return
  74             the result of the job. The concrete semantics is service-dependent.
  75             But it should be possible to
  76             <ul>
  77                 <li>deregister the job</li>
  78                 <li>let him registered although execution was successfully(!)</li>
  79                 <li>make some job specific data persistent inside the job configuration which
  80                     is provided by the executor.</li>
  81             </ul>
  82
  83         @throws com::sun::star::lang::IllegalArgumentException
  84             if some of given arguments doesn't fill out the service specification or
  85             was corrupt so the service couldn't work correctly
  86
  87         @throws com::sun::star::uno::Exception
  88             to notify the excutor about faild operation; otherwise the return value
  89             indicates a successfull finishing.
  90     */
  91     any execute(
  92         [in] sequence< com::sun::star::beans::NamedValue > Arguments )
  93             raises( com::sun::star::lang::IllegalArgumentException ,
  94                     com::sun::star::uno::Exception                 );
  95 };
  96
  97 }; }; }; };
  98
  99 #endif