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