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

interface XJob
Base Hierarchy
::com::sun::star::uno::XInterface
 |
 +-XJob
Description
specifies a job which is to be executed synchronously

Instead of XAsyncJob the implementation of this interface must be a real synchronous one. For example: UI relevant service MUST do so. It's not allowed to make such things asynchronously - because showing of any e.g. dialogs if may some other dialogs come up can produce errors.

See also
XAsyncJob

Methods' Summary
execute executes the job synchronously
Methods' Details
execute
any
execute(
 
[in] sequence< ::com::sun::star::beans::NamedValue

raises(

 
Arguments ) 
::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