1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_task_XJobExecutor_idl__
29#define __com_sun_star_task_XJobExecutor_idl__
30
31#ifndef __com_sun_star_uno_XInterface_idl__
32#include <com/sun/star/uno/XInterface.idl>
33#endif
34
35//=============================================================================
36
37module com {  module sun {  module star {  module task {
38
39//=============================================================================
40/** starts action for any triggered event from outside
41
42    <p>
43    If somewhere from outside trigger an event on this interface
44    it will be used to find any registered service inside configuration
45    of this executor. If somewhere could be found it will be
46    started and controlled by this instance. After it finish his work
47    it's possible to deactivate further startups or let him run again if
48    a new event will be detected later.
49    </p>
50
51    @see JobExecutor
52 */
53published interface XJobExecutor : com::sun::star::uno::XInterface
54{
55	//-------------------------------------------------------------------------
56    /** trigger event to start registered jobs
57
58        <p>
59        Jobs are registered in configuration and will be started by executor
60        automaticly, if they are registered for triggered event.
61        The meaning of given string <var>Event</var> mustn't be known. Because
62        for the executor it's enough to use it for searching a registered job
63        inside his own configuration. So no special events will be defined here.
64        </p>
65
66        @param Event
67                describe the event for which jobs can be registered and should be started
68	*/
69    [oneway] void trigger( [in] string Event );
70};
71
72}; }; }; };
73
74#endif
75