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_XJob_idl__ 29#define __com_sun_star_task_XJob_idl__ 30 31#ifndef __com_sun_star_uno_XInterface_idl__ 32#include <com/sun/star/uno/XInterface.idl> 33#endif 34 35#ifndef __com_sun_star_beans_NamedValue_idl__ 36#include <com/sun/star/beans/NamedValue.idl> 37#endif 38 39#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 40#include <com/sun/star/lang/IllegalArgumentException.idl> 41#endif 42 43//============================================================================ 44 45module com { module sun { module star { module task { 46 47//============================================================================= 48/** specifies a job which is to be executed synchronously 49 50 <p> 51 Instead of <type>XAsyncJob</type> the implementation of this interface 52 will be executed synchronously everytimes. That means: they can be shure that the 53 current stack context will be blocked till this job finish it's work. 54 </p> 55 56 @see XAsyncJob 57*/ 58published interface XJob : com::sun::star::uno::XInterface 59{ 60 //------------------------------------------------------------------------ 61 /** executes the job synchronously 62 63 @param Arguments 64 are arguments for executing the job. Their semantics is completely implementation dependent. Usually, 65 a concrete implementation of a job specifies in its service descriptions which parameters are allowed 66 (or expected). This values are persistent by the configuration of the <type>JobExecutor</type> 67 which use this synchronous job. It's possible to write it back by use special protocol 68 in return value. 69 70 @return 71 the result of the job. The concrete semantics is service-dependent. 72 But it should be possible to 73 <ul> 74 <li>deregister the job</li> 75 <li>let him registered although execution was successfully(!)</li> 76 <li>make some job specific data persistent inside the job configuration which 77 is provided by the executor.</li> 78 </ul> 79 80 @throws com::sun::star::lang::IllegalArgumentException 81 if some of given arguments doesn't fill out the service specification or 82 was corrupt so the service couldn't work correctly 83 84 @throws com::sun::star::uno::Exception 85 to notify the excutor about faild operation; otherwise the return value 86 indicates a successfull finishing. 87 */ 88 any execute( 89 [in] sequence< com::sun::star::beans::NamedValue > Arguments ) 90 raises( com::sun::star::lang::IllegalArgumentException , 91 com::sun::star::uno::Exception ); 92}; 93 94}; }; }; }; 95 96#endif 97