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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
|
/*************************************************************************
*
* $RCSfile: XJob.idl,v $
*
* $Revision: 1.6 $
*
* last change: $Author: hr $ $Date: 2003-04-04 17:44:07 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library 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 for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (the "License"); You may not use this file
* except in compliance with the License. You may obtain a copy of the
* License at http://www.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc..
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef __com_sun_star_task_XJob_idl__
#define __com_sun_star_task_XJob_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_beans_NamedValue_idl__
#include <com/sun/star/beans/NamedValue.idl>
#endif
#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif
//============================================================================
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 everytimes. That means: they can be shure that the
current stack context will be blocked till this job finish it's work.
</p>
@see XAsyncJob
*/
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 excutor about faild operation; otherwise the return value
indicates a successfull finishing.
*/
any execute(
[in] sequence< com::sun::star::beans::NamedValue > Arguments )
raises( com::sun::star::lang::IllegalArgumentException ,
com::sun::star::uno::Exception );
};
}; }; }; };
#endif
|
