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_XAsyncJob_idl__ 29#define __com_sun_star_task_XAsyncJob_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 published interface XJobListener; 48 49//============================================================================= 50/** specifies a job which must be executed asynchronously 51 52 <p> 53 Instead of <type>XJob</type> the implementation of this interface 54 must be aware, that execution can be made real asynchronous (e.g. by using 55 threads). Because the environment whish to have creation and using of threads 56 under control, it's not allowed for a real job implementation to use such mechanism 57 by itself. The outside code decide, if it's possible and how it can be made 58 asynchronous. In some special cases it can be, that asynchronous jobs will be executed 59 synchronously. 60 </p> 61 62 @see XJob 63*/ 64published interface XAsyncJob : com::sun::star::uno::XInterface 65{ 66 //------------------------------------------------------------------------ 67 /** executes the job asynchronously 68 69 @param Arguments 70 are arguments for executing the job. Their semantics is completely implementation dependent. Usually, 71 a concrete implementation of a job specifies in its service descriptions which parameters are allowed 72 (or expected). This values are persistent by the configuration of the <type>JobExecutor</type> 73 which use this asynchronous job. It's possible to write it back by called listener 74 function <member>XJobListener::jobFinished()</member>. 75 76 @param Listener 77 specifies a listener which should be notified on events. May be <NULL/>. 78 79 @throws com::sun::star::lang::IllegalArgumentException 80 if some of given arguments doesn't fill out the service specification or 81 was corrupt so the service couldn't work correctly 82 */ 83 void executeAsync( 84 [in] sequence< com::sun::star::beans::NamedValue > Arguments, 85 [in] XJobListener Listener) 86 raises( com::sun::star::lang::IllegalArgumentException ); 87}; 88 89}; }; }; }; 90 91#endif 92 93