summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/task
diff options
context:
space:
mode:
authorMatúš Kukan <matus.kukan@collabora.com>2014-01-22 14:05:06 +0100
committerStephan Bergmann <sbergman@redhat.com>2014-01-24 14:24:34 +0000
commitef597d80dc18f9662a50f3abad5d39d0fd76449e (patch)
tree343c0be676a4c41c76e1e14e3a3e48c9aa1329dd /offapi/com/sun/star/task
parent4b1ecc4c7da84eee69c583222b62afbf6afed3ab (diff)
Introduce com.sun.star.task.theJobExecutor singleton.
To replace com.sun.star.task.JobExecutor single-instance service, incorrectly converted in 748aa84e9808ad31c6ff6b71459525c82de10e58 [including changes by Stephan Bergmann <sbergman@redhat.com>] Change-Id: I4cea2c63a20b5b22f6e1f822fb35fcc4d0397687 Reviewed-on: https://gerrit.libreoffice.org/7609 Reviewed-by: Stephan Bergmann <sbergman@redhat.com> Tested-by: Stephan Bergmann <sbergman@redhat.com>
Diffstat (limited to 'offapi/com/sun/star/task')
-rw-r--r--offapi/com/sun/star/task/AsyncJob.idl4
-rw-r--r--offapi/com/sun/star/task/Job.idl4
-rw-r--r--offapi/com/sun/star/task/JobExecutor.idl16
-rw-r--r--offapi/com/sun/star/task/XAsyncJob.idl2
-rw-r--r--offapi/com/sun/star/task/XJob.idl2
-rw-r--r--offapi/com/sun/star/task/XJobExecutor.idl2
-rw-r--r--offapi/com/sun/star/task/XJobListener.idl4
-rw-r--r--offapi/com/sun/star/task/theJobExecutor.idl43
8 files changed, 56 insertions, 21 deletions
diff --git a/offapi/com/sun/star/task/AsyncJob.idl b/offapi/com/sun/star/task/AsyncJob.idl
index f11e9532a829..6482cf7e4572 100644
--- a/offapi/com/sun/star/task/AsyncJob.idl
+++ b/offapi/com/sun/star/task/AsyncJob.idl
@@ -26,8 +26,8 @@
module com { module sun { module star { module task {
-/** represent an asynchronous job, which can be executed by the global JobExecutor
- instance.
+/** Represent an asynchronous job, which can be executed by the global
+ theJobExecutor instance.
@see Job
diff --git a/offapi/com/sun/star/task/Job.idl b/offapi/com/sun/star/task/Job.idl
index 69a5305b53f2..414975e5266f 100644
--- a/offapi/com/sun/star/task/Job.idl
+++ b/offapi/com/sun/star/task/Job.idl
@@ -26,8 +26,8 @@
module com { module sun { module star { module task {
-/** represent a synchronous job, which can be executed by the global JobExecutor
- instance.
+/** Represent a synchronous job, which can be executed by the global
+ theJobExecutor instance.
@see AsyncJob
diff --git a/offapi/com/sun/star/task/JobExecutor.idl b/offapi/com/sun/star/task/JobExecutor.idl
index 41737f3fd04a..14d5b581c9b6 100644
--- a/offapi/com/sun/star/task/JobExecutor.idl
+++ b/offapi/com/sun/star/task/JobExecutor.idl
@@ -25,18 +25,10 @@
module com { module sun { module star { module task {
-/** generic job execution service
-
- <p>
- Can start registered uno services on triggered events and handle there
- own configuration and there lifetime. Such events are simple strings
- which meaning doesn't matter for any real service implementation of this
- specification. But triggered events must be available inside the
- configuration and some Jobs or AsyncJobs must be registered for that.
- </p>
-
- @see Job
- @see AsyncJob
+/**
+ A legacy (single-instance) service-variant of theJobExecutor singleton.
+
+ @deprecated Use theJobExecutor singleton instead.
*/
published service JobExecutor : XJobExecutor;
diff --git a/offapi/com/sun/star/task/XAsyncJob.idl b/offapi/com/sun/star/task/XAsyncJob.idl
index 9b868ae1c105..1750b5e36c78 100644
--- a/offapi/com/sun/star/task/XAsyncJob.idl
+++ b/offapi/com/sun/star/task/XAsyncJob.idl
@@ -50,7 +50,7 @@ published interface XAsyncJob : com::sun::star::uno::XInterface
@param 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
+ (or expected). This values are persistent by the configuration of theJobExecutor
which use this asynchronous job. It's possible to write it back by called listener
function XJobListener::jobFinished().
diff --git a/offapi/com/sun/star/task/XJob.idl b/offapi/com/sun/star/task/XJob.idl
index 54b50b488ae6..6c8daf2761c6 100644
--- a/offapi/com/sun/star/task/XJob.idl
+++ b/offapi/com/sun/star/task/XJob.idl
@@ -44,7 +44,7 @@ published interface XJob : com::sun::star::uno::XInterface
@param 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
+ (or expected). This values are persistent by the configuration of theJobExecutor
which use this synchronous job. It's possible to write it back by use special protocol
in return value.
diff --git a/offapi/com/sun/star/task/XJobExecutor.idl b/offapi/com/sun/star/task/XJobExecutor.idl
index 6cd3a093db66..b27468cf423a 100644
--- a/offapi/com/sun/star/task/XJobExecutor.idl
+++ b/offapi/com/sun/star/task/XJobExecutor.idl
@@ -36,7 +36,7 @@ module com { module sun { module star { module task {
a new event will be detected later.
</p>
- @see JobExecutor
+ @see theJobExecutor
*/
published interface XJobExecutor : com::sun::star::uno::XInterface
{
diff --git a/offapi/com/sun/star/task/XJobListener.idl b/offapi/com/sun/star/task/XJobListener.idl
index 0bdbf4db4f6c..93634a8c342e 100644
--- a/offapi/com/sun/star/task/XJobListener.idl
+++ b/offapi/com/sun/star/task/XJobListener.idl
@@ -34,14 +34,14 @@ published interface XJobListener : com::sun::star::lang::XEventListener
/** indicates that the job is done
@param Job
- identifies the asynchronous job so the JobExecutor
+ identifies the asynchronous job so that theJobExecutor
can differ between more then ones.
@param 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
- JobExecutor and a real job. So it can be possible to:
+ theJobExecutor and a real job. So it can be possible to:
<ul>
<li>deregister the job</li>
diff --git a/offapi/com/sun/star/task/theJobExecutor.idl b/offapi/com/sun/star/task/theJobExecutor.idl
new file mode 100644
index 000000000000..6189938aed3f
--- /dev/null
+++ b/offapi/com/sun/star/task/theJobExecutor.idl
@@ -0,0 +1,43 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+
+#ifndef __com_sun_star_task_theJobExecutor_idl__
+#define __com_sun_star_task_theJobExecutor_idl__
+
+#include <com/sun/star/task/XJobExecutor.idl>
+
+
+module com { module sun { module star { module task {
+
+/**
+ Generic job execution singleton
+
+ <p>
+ Can start registered uno services on triggered events and handle there
+ own configuration and there lifetime. Such events are simple strings
+ which meaning doesn't matter for any real service implementation of this
+ specification. But triggered events must be available inside the
+ configuration and some Jobs or AsyncJobs must be registered for that.
+ </p>
+
+ Prior to LibreOffice 4.3, this singleton was only available as a
+ (single-instance) JobExecutor service.
+
+ @see Job
+ @see AsyncJob
+
+ @since LibreOffice 4.3
+ */
+published singleton theJobExecutor : XJobExecutor;
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */