1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_task_XJobExecutor_idl__
25#define __com_sun_star_task_XJobExecutor_idl__
26
27#ifndef __com_sun_star_uno_XInterface_idl__
28#include <com/sun/star/uno/XInterface.idl>
29#endif
30
31//=============================================================================
32
33module com {  module sun {  module star {  module task {
34
35//=============================================================================
36/** starts action for any triggered event from outside
37
38    <p>
39    If somewhere from outside trigger an event on this interface
40    it will be used to find any registered service inside configuration
41    of this executor. If somewhere could be found it will be
42    started and controlled by this instance. After it finish his work
43    it's possible to deactivate further startups or let him run again if
44    a new event will be detected later.
45    </p>
46
47    @see JobExecutor
48 */
49published interface XJobExecutor : com::sun::star::uno::XInterface
50{
51	//-------------------------------------------------------------------------
52    /** trigger event to start registered jobs
53
54        <p>
55        Jobs are registered in configuration and will be started by executor
56        automatically, if they are registered for triggered event.
57        The meaning of given string <var>Event</var> mustn't be known. Because
58        for the executor it's enough to use it for searching a registered job
59        inside his own configuration. So no special events will be defined here.
60        </p>
61
62        @param Event
63                describe the event for which jobs can be registered and should be started
64	*/
65    [oneway] void trigger( [in] string Event );
66};
67
68}; }; }; };
69
70#endif
71