Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

interface XJob
Description
specifies a job which is to be executed synchronously

Instead of XAsyncJob the implementation of this interface will be executed synchronously everytimes. That means: they can be shure that the current stack context will be blocked till this job finish it's work.

See also
XAsyncJob
Developers Guide
WritingUNO - Jobs - Implementation

Methods' Summary
execute executes the job synchronously  
Methods' Details
execute
any
execute( [in] sequence< ::com::sun::star::beans::NamedValue >  Arguments )
raises( ::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::uno::Exception );

Description
executes the job synchronously
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 synchronous job. It's possible to write it back by use special protocol in return value.
Returns
the result of the job. The concrete semantics is service-dependent. But it should be possible to
  • deregister the job
  • let him registered although execution was successfully(!)
  • make some job specific data persistent inside the job configuration which is provided by the executor.
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
Throws
com::sun::star::uno::Exception to notify the excutor about faild operation; otherwise the return value indicates a successfull finishing.
Top of Page

Apache Software Foundation

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

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