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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_task_XJob_idl__
  21 #define __com_sun_star_task_XJob_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/beans/NamedValue.idl>
  25 #include <com/sun/star/lang/IllegalArgumentException.idl>
  26
  27
  28 module com {  module sun {  module star {  module task {
  29
  30 /** specifies a job which is to be executed synchronously
  31
  32     <p>
  33     Instead of XAsyncJob the implementation of this interface
  34     will be executed synchronously every time. That means: they can be sure that the
  35     current stack context will be blocked till this job finish it's work.
  36     </p>
  37
  38     @see XAsyncJob
  39 */
  40 published interface XJob : com::sun::star::uno::XInterface
  41 {
  42     /** executes the job synchronously
  43
  44         @param Arguments
  45             are arguments for executing the job. Their semantics is completely implementation dependent. Usually,
  46             a concrete implementation of a job specifies in its service descriptions which parameters are allowed
  47             (or expected). This values are persistent by the configuration of theJobExecutor
  48             which use this synchronous job. It's possible to write it back by use special protocol
  49             in return value.
  50
  51         @return
  52             the result of the job. The concrete semantics is service-dependent.
  53             But it should be possible to
  54             <ul>
  55                 <li>deregister the job</li>
  56                 <li>let him registered although execution was successfully(!)</li>
  57                 <li>make some job specific data persistent inside the job configuration which
  58                     is provided by the executor.</li>
  59             </ul>
  60
  61         @throws com::sun::star::lang::IllegalArgumentException
  62             if some of given arguments doesn't fill out the service specification or
  63             was corrupt so the service couldn't work correctly
  64
  65         @throws com::sun::star::uno::Exception
  66             to notify the executor about failed operation; otherwise the return value
  67             indicates a successful finishing.
  68     */
  69     any execute(
  70         [in] sequence< com::sun::star::beans::NamedValue > Arguments )
  71             raises( com::sun::star::lang::IllegalArgumentException ,
  72                     com::sun::star::uno::Exception                 );
  73 };
  74
  75 }; }; }; };
  76
  77 #endif
  78
  79 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */