1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir 24cdf0e10cSrcweir#ifndef __com_sun_star_task_XAsyncJob_idl__ 25cdf0e10cSrcweir#define __com_sun_star_task_XAsyncJob_idl__ 26cdf0e10cSrcweir 27cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 28cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 29cdf0e10cSrcweir#endif 30cdf0e10cSrcweir 31cdf0e10cSrcweir#ifndef __com_sun_star_beans_NamedValue_idl__ 32cdf0e10cSrcweir#include <com/sun/star/beans/NamedValue.idl> 33cdf0e10cSrcweir#endif 34cdf0e10cSrcweir 35cdf0e10cSrcweir#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 36cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl> 37cdf0e10cSrcweir#endif 38cdf0e10cSrcweir 39cdf0e10cSrcweir//============================================================================= 40cdf0e10cSrcweir 41cdf0e10cSrcweirmodule com { module sun { module star { module task { 42cdf0e10cSrcweir 43cdf0e10cSrcweir published interface XJobListener; 44cdf0e10cSrcweir 45cdf0e10cSrcweir//============================================================================= 46cdf0e10cSrcweir/** specifies a job which must be executed asynchronously 47cdf0e10cSrcweir 48cdf0e10cSrcweir <p> 49cdf0e10cSrcweir Instead of <type>XJob</type> the implementation of this interface 50cdf0e10cSrcweir must be aware, that execution can be made real asynchronous (e.g. by using 51cdf0e10cSrcweir threads). Because the environment whish to have creation and using of threads 52cdf0e10cSrcweir under control, it's not allowed for a real job implementation to use such mechanism 53cdf0e10cSrcweir by itself. The outside code decide, if it's possible and how it can be made 54cdf0e10cSrcweir asynchronous. In some special cases it can be, that asynchronous jobs will be executed 55cdf0e10cSrcweir synchronously. 56cdf0e10cSrcweir </p> 57cdf0e10cSrcweir 58cdf0e10cSrcweir @see XJob 59cdf0e10cSrcweir*/ 60cdf0e10cSrcweirpublished interface XAsyncJob : com::sun::star::uno::XInterface 61cdf0e10cSrcweir{ 62cdf0e10cSrcweir //------------------------------------------------------------------------ 63cdf0e10cSrcweir /** executes the job asynchronously 64cdf0e10cSrcweir 65cdf0e10cSrcweir @param Arguments 66cdf0e10cSrcweir are arguments for executing the job. Their semantics is completely implementation dependent. Usually, 67cdf0e10cSrcweir a concrete implementation of a job specifies in its service descriptions which parameters are allowed 68cdf0e10cSrcweir (or expected). This values are persistent by the configuration of the <type>JobExecutor</type> 69cdf0e10cSrcweir which use this asynchronous job. It's possible to write it back by called listener 70cdf0e10cSrcweir function <member>XJobListener::jobFinished()</member>. 71cdf0e10cSrcweir 72cdf0e10cSrcweir @param Listener 73cdf0e10cSrcweir specifies a listener which should be notified on events. May be <NULL/>. 74cdf0e10cSrcweir 75cdf0e10cSrcweir @throws com::sun::star::lang::IllegalArgumentException 76cdf0e10cSrcweir if some of given arguments doesn't fill out the service specification or 77cdf0e10cSrcweir was corrupt so the service couldn't work correctly 78cdf0e10cSrcweir */ 79cdf0e10cSrcweir void executeAsync( 80cdf0e10cSrcweir [in] sequence< com::sun::star::beans::NamedValue > Arguments, 81cdf0e10cSrcweir [in] XJobListener Listener) 82cdf0e10cSrcweir raises( com::sun::star::lang::IllegalArgumentException ); 83cdf0e10cSrcweir}; 84cdf0e10cSrcweir 85cdf0e10cSrcweir}; }; }; }; 86cdf0e10cSrcweir 87cdf0e10cSrcweir#endif 88cdf0e10cSrcweir 89