1*cdf0e10cSrcweir/************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir 28*cdf0e10cSrcweir#ifndef __com_sun_star_task_XAsyncJob_idl__ 29*cdf0e10cSrcweir#define __com_sun_star_task_XAsyncJob_idl__ 30*cdf0e10cSrcweir 31*cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 32*cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 33*cdf0e10cSrcweir#endif 34*cdf0e10cSrcweir 35*cdf0e10cSrcweir#ifndef __com_sun_star_beans_NamedValue_idl__ 36*cdf0e10cSrcweir#include <com/sun/star/beans/NamedValue.idl> 37*cdf0e10cSrcweir#endif 38*cdf0e10cSrcweir 39*cdf0e10cSrcweir#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 40*cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl> 41*cdf0e10cSrcweir#endif 42*cdf0e10cSrcweir 43*cdf0e10cSrcweir//============================================================================= 44*cdf0e10cSrcweir 45*cdf0e10cSrcweirmodule com { module sun { module star { module task { 46*cdf0e10cSrcweir 47*cdf0e10cSrcweir published interface XJobListener; 48*cdf0e10cSrcweir 49*cdf0e10cSrcweir//============================================================================= 50*cdf0e10cSrcweir/** specifies a job which must be executed asynchronously 51*cdf0e10cSrcweir 52*cdf0e10cSrcweir <p> 53*cdf0e10cSrcweir Instead of <type>XJob</type> the implementation of this interface 54*cdf0e10cSrcweir must be aware, that execution can be made real asynchronous (e.g. by using 55*cdf0e10cSrcweir threads). Because the environment whish to have creation and using of threads 56*cdf0e10cSrcweir under control, it's not allowed for a real job implementation to use such mechanism 57*cdf0e10cSrcweir by itself. The outside code decide, if it's possible and how it can be made 58*cdf0e10cSrcweir asynchronous. In some special cases it can be, that asynchronous jobs will be executed 59*cdf0e10cSrcweir synchronously. 60*cdf0e10cSrcweir </p> 61*cdf0e10cSrcweir 62*cdf0e10cSrcweir @see XJob 63*cdf0e10cSrcweir*/ 64*cdf0e10cSrcweirpublished interface XAsyncJob : com::sun::star::uno::XInterface 65*cdf0e10cSrcweir{ 66*cdf0e10cSrcweir //------------------------------------------------------------------------ 67*cdf0e10cSrcweir /** executes the job asynchronously 68*cdf0e10cSrcweir 69*cdf0e10cSrcweir @param Arguments 70*cdf0e10cSrcweir are arguments for executing the job. Their semantics is completely implementation dependent. Usually, 71*cdf0e10cSrcweir a concrete implementation of a job specifies in its service descriptions which parameters are allowed 72*cdf0e10cSrcweir (or expected). This values are persistent by the configuration of the <type>JobExecutor</type> 73*cdf0e10cSrcweir which use this asynchronous job. It's possible to write it back by called listener 74*cdf0e10cSrcweir function <member>XJobListener::jobFinished()</member>. 75*cdf0e10cSrcweir 76*cdf0e10cSrcweir @param Listener 77*cdf0e10cSrcweir specifies a listener which should be notified on events. May be <NULL/>. 78*cdf0e10cSrcweir 79*cdf0e10cSrcweir @throws com::sun::star::lang::IllegalArgumentException 80*cdf0e10cSrcweir if some of given arguments doesn't fill out the service specification or 81*cdf0e10cSrcweir was corrupt so the service couldn't work correctly 82*cdf0e10cSrcweir */ 83*cdf0e10cSrcweir void executeAsync( 84*cdf0e10cSrcweir [in] sequence< com::sun::star::beans::NamedValue > Arguments, 85*cdf0e10cSrcweir [in] XJobListener Listener) 86*cdf0e10cSrcweir raises( com::sun::star::lang::IllegalArgumentException ); 87*cdf0e10cSrcweir}; 88*cdf0e10cSrcweir 89*cdf0e10cSrcweir}; }; }; }; 90*cdf0e10cSrcweir 91*cdf0e10cSrcweir#endif 92*cdf0e10cSrcweir 93