xref: /trunk/main/offapi/com/sun/star/task/XJobListener.idl (revision d1766043)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/



#ifndef __com_sun_star_task_XJobListener_idl__
#define __com_sun_star_task_XJobListener_idl__

#ifndef __com_sun_star_lang_XEventListener_idl__
#include <com/sun/star/lang/XEventListener.idl>
#endif

//=============================================================================

module com {  module sun {  module star {  module task {

 published interface XAsyncJob;

//=============================================================================
/** listener on finish states of asynchronous job execution
 */
published interface XJobListener : com::sun::star::lang::XEventListener
{
    //------------------------------------------------------------------------
    /** indicates that the job is done

        @param Job
            identifies the asynchronous job so the <type>JobExecutor</type>
            can differ between more then ones.

        @param Result
            should be the same like for the synchronous mode on <member>XJob::execute()</member>.
            It provides information about success or failure of job execution. It's possible too,
            to use special protocol (which depends from real implementation) between
            <type>JobExecutor</type> and a real job. So it can be possible to:

            <ul>
                <li>deregister the job</li>
                <li>let him registered although execution was successfully(!)</li>
                <li>make some job specific data persistent inside the job configuration which
                    is provided by the executor.</li>
            </ul>
	*/
    void jobFinished(
        [in] XAsyncJob Job,
        [in] any Result);
};

}; }; }; };

#endif