offapi/com/sun/star/task/XAsyncJob.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_XAsyncJob_idl__
  21 #define __com_sun_star_task_XAsyncJob_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  published interface XJobListener;
  31
  32 /** specifies a job which must be executed asynchronously
  33
  34     <p>
  35     Instead of XJob the implementation of this interface
  36     must be aware, that execution can be made real asynchronous (e.g. by using
  37     threads). Because the environment wish to have creation and using of threads
  38     under control, it's not allowed for a real job implementation to use such mechanism
  39     by itself. The outside code decide, if it's possible and how it can be made
  40     asynchronous. In some special cases it can be, that asynchronous jobs will be executed
  41     synchronously.
  42     </p>
  43
  44     @see XJob
  45 */
  46 published interface XAsyncJob : com::sun::star::uno::XInterface
  47 {
  48     /** executes the job asynchronously
  49
  50         @param Arguments
  51             are arguments for executing the job. Their semantics is completely implementation dependent. Usually,
  52             a concrete implementation of a job specifies in its service descriptions which parameters are allowed
  53             (or expected). This values are persistent by the configuration of theJobExecutor
  54             which use this asynchronous job. It's possible to write it back by called listener
  55             function XJobListener::jobFinished().
  56
  57         @param Listener
  58             specifies a listener which should be notified on events. May be `NULL`.
  59
  60         @throws com::sun::star::lang::IllegalArgumentException
  61             if some of given arguments doesn't fill out the service specification or
  62             was corrupt so the service couldn't work correctly
  63     */
  64    void executeAsync(
  65         [in] sequence< com::sun::star::beans::NamedValue > Arguments,
  66         [in] XJobListener Listener)
  67             raises( com::sun::star::lang::IllegalArgumentException );
  68 };
  69
  70 }; }; }; };
  71
  72 #endif
  73
  74 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */