1d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5d1766043SAndrew Rist * distributed with this work for additional information 6d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10d1766043SAndrew Rist * 11d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12d1766043SAndrew Rist * 13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14d1766043SAndrew Rist * software distributed under the License is distributed on an 15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17d1766043SAndrew Rist * specific language governing permissions and limitations 18d1766043SAndrew Rist * under the License. 19d1766043SAndrew Rist * 20d1766043SAndrew Rist *************************************************************/ 21d1766043SAndrew Rist 22d1766043SAndrew Rist 23cdf0e10cSrcweir 24cdf0e10cSrcweir#ifndef __com_sun_star_task_XJob_idl__ 25cdf0e10cSrcweir#define __com_sun_star_task_XJob_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//============================================================================= 44cdf0e10cSrcweir/** specifies a job which is to be executed synchronously 45cdf0e10cSrcweir 46cdf0e10cSrcweir <p> 47cdf0e10cSrcweir Instead of <type>XAsyncJob</type> the implementation of this interface 48cdf0e10cSrcweir will be executed synchronously everytimes. That means: they can be shure that the 49cdf0e10cSrcweir current stack context will be blocked till this job finish it's work. 50cdf0e10cSrcweir </p> 51cdf0e10cSrcweir 52cdf0e10cSrcweir @see XAsyncJob 53cdf0e10cSrcweir*/ 54cdf0e10cSrcweirpublished interface XJob : com::sun::star::uno::XInterface 55cdf0e10cSrcweir{ 56cdf0e10cSrcweir //------------------------------------------------------------------------ 57cdf0e10cSrcweir /** executes the job synchronously 58cdf0e10cSrcweir 59cdf0e10cSrcweir @param Arguments 60cdf0e10cSrcweir are arguments for executing the job. Their semantics is completely implementation dependent. Usually, 61cdf0e10cSrcweir a concrete implementation of a job specifies in its service descriptions which parameters are allowed 62cdf0e10cSrcweir (or expected). This values are persistent by the configuration of the <type>JobExecutor</type> 63cdf0e10cSrcweir which use this synchronous job. It's possible to write it back by use special protocol 64cdf0e10cSrcweir in return value. 65cdf0e10cSrcweir 66cdf0e10cSrcweir @return 67cdf0e10cSrcweir the result of the job. The concrete semantics is service-dependent. 68cdf0e10cSrcweir But it should be possible to 69cdf0e10cSrcweir <ul> 70cdf0e10cSrcweir <li>deregister the job</li> 71cdf0e10cSrcweir <li>let him registered although execution was successfully(!)</li> 72cdf0e10cSrcweir <li>make some job specific data persistent inside the job configuration which 73cdf0e10cSrcweir is provided by the executor.</li> 74cdf0e10cSrcweir </ul> 75cdf0e10cSrcweir 76cdf0e10cSrcweir @throws com::sun::star::lang::IllegalArgumentException 77cdf0e10cSrcweir if some of given arguments doesn't fill out the service specification or 78cdf0e10cSrcweir was corrupt so the service couldn't work correctly 79cdf0e10cSrcweir 80cdf0e10cSrcweir @throws com::sun::star::uno::Exception 81cdf0e10cSrcweir to notify the excutor about faild operation; otherwise the return value 82*a893be29SPedro Giffuni indicates a successful finishing. 83cdf0e10cSrcweir */ 84cdf0e10cSrcweir any execute( 85cdf0e10cSrcweir [in] sequence< com::sun::star::beans::NamedValue > Arguments ) 86cdf0e10cSrcweir raises( com::sun::star::lang::IllegalArgumentException , 87cdf0e10cSrcweir com::sun::star::uno::Exception ); 88cdf0e10cSrcweir}; 89cdf0e10cSrcweir 90cdf0e10cSrcweir}; }; }; }; 91cdf0e10cSrcweir 92cdf0e10cSrcweir#endif 93