blob: 18f66ed72d69b213145346f4ad0592a2280e3f04 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_task_XJob_idl__
#define __com_sun_star_task_XJob_idl__
#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/beans/NamedValue.idl>
#include <com/sun/star/lang/IllegalArgumentException.idl>
module com { module sun { module star { module task {
/** specifies a job which is to be executed synchronously
<p>
Instead of <type>XAsyncJob</type> the implementation of this interface
will be executed synchronously everytime. That means: they can be sure that the
current stack context will be blocked till this job finish it's work.
</p>
@see XAsyncJob
*/
published interface XJob : com::sun::star::uno::XInterface
{
/** executes the job synchronously
@param Arguments
are arguments for executing the job. Their semantics is completely implementation dependent. Usually,
a concrete implementation of a job specifies in its service descriptions which parameters are allowed
(or expected). This values are persistent by the configuration of the <type>JobExecutor</type>
which use this synchronous job. It's possible to write it back by use special protocol
in return value.
@return
the result of the job. The concrete semantics is service-dependent.
But it should be possible to
<ul>
<li>deregister the job</li>
<li>let him registered although execution was successfully(!)</li>
<li>make some job specific data persistent inside the job configuration which
is provided by the executor.</li>
</ul>
@throws com::sun::star::lang::IllegalArgumentException
if some of given arguments doesn't fill out the service specification or
was corrupt so the service couldn't work correctly
@throws com::sun::star::uno::Exception
to notify the executor about failed operation; otherwise the return value
indicates a successful finishing.
*/
any execute(
[in] sequence< com::sun::star::beans::NamedValue > Arguments )
raises( com::sun::star::lang::IllegalArgumentException ,
com::sun::star::uno::Exception );
};
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
