Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous


:: com :: sun :: star :: task ::

interface XAsyncJob
Description
specifies a job which must be executed asynchronously

Instead of XJob the implementation of this interface must be aware, that execution can be made real asynchronous (e.g. by using threads). Because the environment whish to have creation and using of threads under control, it's not allowed for a real job implementation to use such mechanism by itself. The outside code decide, if it's possible and how it can be made asynchronous. In some special cases it can be, that asynchronous jobs will be executed synchronously.

See also
XJob
Developers Guide
WritingUNO - Jobs - Implementation

Methods' Summary
executeAsync executes the job asynchronously  
Methods' Details
executeAsync
void
executeAsync( [in] sequence< ::com::sun::star::beans::NamedValue >  Arguments,
[in] XJobListener  Listener )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
executes the job asynchronously
Parameter Arguments
are arguments for executing the job. Their semantics is completely implementation dependent. Usually, a concrete implementation of a job specifies in its service descriptions which parameters are allowed (or expected). This values are persistent by the configuration of the JobExecutor which use this asynchronous job. It's possible to write it back by called listener function XJobListener::jobFinished().
Parameter Listener
specifies a listener which should be notified on events. May be NULL.
Throws
com::sun::star::lang::IllegalArgumentException if some of given arguments doesn't fill out the service specification or was corrupt so the service couldn't work correctly
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.