(incubating) | The Free and Open Productivity Suite

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous

Content for OpenOffice.org version 3.3.
Overview Module Use Devguide Index
Methods' Summary Attributes' Summary Methods' Details Attributes' Details

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

Copyright © 1995, 2010, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Apache OpenOffice is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.

Copyright & License
Apache and the Apache feather logos are trademarks of The Apache Software Foundation. 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.