offapi/com/sun/star/task/XJobExecutor.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_XJobExecutor_idl__
  21 #define __com_sun_star_task_XJobExecutor_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24
  25
  26 module com {  module sun {  module star {  module task {
  27
  28 /** starts action for any triggered event from outside
  29
  30     <p>
  31     If somewhere from outside trigger an event on this interface
  32     it will be used to find any registered service inside configuration
  33     of this executor. If somewhere could be found it will be
  34     started and controlled by this instance. After it finish his work
  35     it's possible to deactivate further startups or let him run again if
  36     a new event will be detected later.
  37     </p>
  38
  39     @see theJobExecutor
  40  */
  41 published interface XJobExecutor : com::sun::star::uno::XInterface
  42 {
  43     /** trigger event to start registered jobs
  44
  45         <p>
  46         Jobs are registered in configuration and will be started by executor
  47         automatically, if they are registered for triggered event.
  48         The meaning of given string <var>Event</var> mustn't be known. Because
  49         for the executor it's enough to use it for searching a registered job
  50         inside his own configuration. So no special events will be defined here.
  51         </p>
  52
  53         @param Event
  54                 describe the event for which jobs can be registered and should be started
  55     */
  56     void trigger( [in] string Event );
  57 };
  58
  59 }; }; }; };
  60
  61 #endif
  62
  63 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */