LibreOffice: XJobListener Interface Reference

LibreOffice LibreOffice 7.5 SDK API Reference

Loading...
Searching...
No Matches
Public Member Functions | List of all members
XJobListener Interface Referencepublished

listener on finish states of asynchronous job execution More...

Inheritance diagram for XJobListener:

## Public Member Functions
void | jobFinished ([in] XAsyncJob Job, [in] any Result)
| indicates that the job is done
Public Member Functions inherited from XEventListener
void | disposing ([in] com::sun::star::lang::EventObject Source)
| gets called when the broadcaster is about to be disposed.
Public Member Functions inherited from XInterface
any | queryInterface ([in] type aType)
| queries for a new interface to an existing UNO object.
void | acquire ()
| increases the reference counter by one.
void | release ()
| decreases the reference counter by one.

## Detailed Description

listener on finish states of asynchronous job execution

## Member Function Documentation

## ◆ jobFinished()

void jobFinished | ( | [in] XAsyncJob | Job,
|  | [in] any | Result
| ) |  |

indicates that the job is done

Parameters

  Job | identifies the asynchronous job so that theJobExecutor can differ between more than ones.
  Result | should be the same like for the synchronous mode on XJob::execute(). It provides information about success or failure of job execution. It's possible too, to use special protocol (which depends from real implementation) between theJobExecutor and a real job. So it can be possible to:

- deregister the job
- let him registered although execution was successful(!)
- make some job specific data persistent inside the job configuration which is provided by the executor.

The documentation for this interface was generated from the following file:

- com/sun/star/task/XJobListener.idl