diff options
Diffstat (limited to 'offapi/com/sun/star/task')
| -rw-r--r-- | offapi/com/sun/star/task/InteractionClassification.idl | 23 | ||||
| -rw-r--r-- | offapi/com/sun/star/task/InteractionHandler.idl | 139 | ||||
| -rw-r--r-- | offapi/com/sun/star/task/JobExecutor.idl | 38 | ||||
| -rw-r--r-- | offapi/com/sun/star/task/NoMasterException.idl | 8 | ||||
| -rw-r--r-- | offapi/com/sun/star/task/PasswordContainer.idl | 114 | ||||
| -rw-r--r-- | offapi/com/sun/star/task/PasswordRequest.idl | 16 | ||||
| -rw-r--r-- | offapi/com/sun/star/task/PasswordRequestMode.idl | 20 | ||||
| -rw-r--r-- | offapi/com/sun/star/task/UrlRecord.idl | 9 | ||||
| -rw-r--r-- | offapi/com/sun/star/task/UserRecord.idl | 9 | ||||
| -rw-r--r-- | offapi/com/sun/star/task/XAsyncJob.idl | 68 | ||||
| -rw-r--r-- | offapi/com/sun/star/task/XJob.idl | 84 | ||||
| -rw-r--r-- | offapi/com/sun/star/task/XJobExecutor.idl | 51 | ||||
| -rw-r--r-- | offapi/com/sun/star/task/XJobListener.idl | 64 | ||||
| -rw-r--r-- | offapi/com/sun/star/task/XStatusIndicator.idl | 175 | ||||
| -rw-r--r-- | offapi/com/sun/star/task/XStatusIndicatorFactory.idl | 98 | ||||
| -rw-r--r-- | offapi/com/sun/star/task/XStatusIndicatorSupplier.idl | 103 |
16 files changed, 601 insertions, 418 deletions
diff --git a/offapi/com/sun/star/task/InteractionClassification.idl b/offapi/com/sun/star/task/InteractionClassification.idl index b2b7d8823..fcdca3a6c 100644 --- a/offapi/com/sun/star/task/InteractionClassification.idl +++ b/offapi/com/sun/star/task/InteractionClassification.idl @@ -2,9 +2,9 @@ * * $RCSfile: InteractionClassification.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: mi $ $Date: 2000-11-08 12:44:23 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:52 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,6 +70,9 @@ // DocMerge from xml: enum com::sun::star::task::InteractionClassification /** A classification of interaction requests. + + @see com::sun::star::task::ClassifiedInteractionRequest + This is the base of classified interaction requests. */ enum InteractionClassification { @@ -91,15 +94,19 @@ enum InteractionClassification // DocMerge from xml: value com::sun::star::task::InteractionClassification::INFO /** Some information for the client/user (which will typically lead to the - selection of an XInteractionApprove continuation). + selection of an + <type scope="com::sun::star::task">XInteractionApprove</type> + continuation). */ INFO, //------------------------------------------------------------------------- // DocMerge from xml: value com::sun::star::task::InteractionClassification::QUERY - /** A query for the client/user, (which will typically lead to the - selection of an XInteractionApprove or XInteractionDisapprove + /** A query for the client/user (which will typically lead to the + selection of an + <type scope="com::sun::star::task">XInteractionApprove</type> or + <type scope="com::sun::star::task">XInteractionDisapprove</type> continuation). */ QUERY @@ -113,6 +120,12 @@ enum InteractionClassification /*============================================================================= $Log: not supported by cvs2svn $ + Revision 1.3.24.1 2002/03/13 10:01:24 sb + #98102# Cosmetic changes. + + Revision 1.3 2000/11/08 12:44:23 mi + moved from api + Revision 1.1.1.1 2000/09/18 23:35:56 hjs initial import diff --git a/offapi/com/sun/star/task/InteractionHandler.idl b/offapi/com/sun/star/task/InteractionHandler.idl index 9a90e2b7d..493bfab25 100644 --- a/offapi/com/sun/star/task/InteractionHandler.idl +++ b/offapi/com/sun/star/task/InteractionHandler.idl @@ -2,9 +2,9 @@ * * $RCSfile: InteractionHandler.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: sb $ $Date: 2001-08-29 09:52:00 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:52 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,67 +72,76 @@ module com { module sun { module star { module task { //============================================================================ /** An interaction request handler that lets the user handle a number of well known requests via GUI dialogs (and the - <type>com::sun::star::task::PasswordContainer</type> service). + <type scope="com::sun::star::task">PasswordContainer</type> service). <P>The well known requests handled by this service include - <type>com::sun::star::java::WrongJavaVersionException</type>*, - <type>com::sun::star::sync2::BadPartnershipException</type>*, - <type>com::sun::star::task::PasswordRequest</type>, - <type>com::sun::star::ucb::AuthenticationRequest</type>, - <type>com::sun::star::ucb::HandleCookiesRequest</type>, - <type>com::sun::star::ucb::InteractiveAugmentedIOException</type>*, - <type>com::sun::star::ucb::InteractiveCHAOSException</type>*, - <type>com::sun::star::ucb::InteractiveFileIOException</type>*, - <type>com::sun::star::ucb::InteractiveIOException</type>*, - <type>com::sun::star::ucb::InteractiveNetworkConnectException</type>*, - <type>com::sun::star::ucb::InteractiveNetworkException</type>*, - <type>com::sun::star::ucb::InteractiveNetworkGeneralException</type>*, - <type>com::sun::star::ucb::InteractiveNetworkOffLineException</type>*, - <type>com::sun::star::ucb::InteractiveNetworkReadException</type>*, - <type>com::sun::star::ucb::InteractiveNetworkResolveNameException</type>*, - <type>com::sun::star::ucb::InteractiveNetworkWriteException</type>*, and - <type>com::sun::star::ucb::InteractiveWrongMediumException</type>*. The - requests marked with an asterisk are only handled if (a) their + <UL> + <LI><type scope="com::sun::star::ucb">AuthenticationRequest</type></LI> + <LI><type scope="com::sun::star::sync2">BadPartnershipException</type>*</LI> + <LI><type scope="com::sun::star::ucb">HandleCookiesRequest</type></LI> + <LI><type scope="com::sun::star::ucb">InteractiveAugmentedIOException</type>*</LI> + <LI><type scope="com::sun::star::ucb">InteractiveCHAOSException</type>*</LI> + <LI><type scope="com::sun::star::ucb">InteractiveFileIOException</type>*</LI> + <LI><type scope="com::sun::star::ucb">InteractiveIOException</type>*</LI> + <LI><type scope="com::sun::star::ucb">InteractiveNetworkConnectException</type>*</LI> + <LI><type scope="com::sun::star::ucb">InteractiveNetworkException</type>*</LI> + <LI><type scope="com::sun::star::ucb">InteractiveNetworkGeneralException</type>*</LI> + <LI><type scope="com::sun::star::ucb">InteractiveNetworkOffLineException</type>*</LI> + <LI><type scope="com::sun::star::ucb">InteractiveNetworkReadException</type>*</LI> + <LI><type scope="com::sun::star::ucb">InteractiveNetworkResolveNameException</type>*</LI> + <LI><type scope="com::sun::star::ucb">InteractiveNetworkWriteException</type>*</LI> + <LI><type scope="com::sun::star::ucb">InteractiveWrongMediumException</type>*</LI> + <LI><type scope="com::sun::star::task">PasswordRequest</type></LI> + <LI><type scope="com::sun::star::java">WrongJavaVersionException</type>*</LI> + </UL> + The requests marked with an asterisk are only handled if (a) their continuations match certain restrictions (see below), and (b) the necessary resource strings are available (this can be exploited by applications that carry only a subset of all resource files with them).</P> - <P>The continuation restrictions are as follows: Let C be the subset of - the provided continuations that are of type - <type>com::sun::star::task::XInteractionApprove</type>, - <type>com::star::task::XInteractionDisapprove</type>, - <type>com::star::task::XInteractionRetry</type>, or - <type>com::star::task::XInteractionAbort</type> (or of a derived type). - All other continuations are ignored for these requests. The request is - only handled if the set C is any of the following: + <P>The continuation restrictions are as follows: Let <VAR>C</VAR> be the + subset of the provided continuations that are of type + <type scope="com::sun::star::task">XInteractionApprove</type>, + <type scope="com::sun::star::task">XInteractionDisapprove</type>, + <type scope="com::sun::star::task">XInteractionRetry</type>, or + <type scope="com::sun::star::task">XInteractionAbort</type> (or of a + derived type). All other continuations are ignored for these requests. + The request is only handled if the set <VAR>C</VAR> is any of the + following: <UL> - <IL>Abort</IL> - <IL>Retry, Abort</IL> - <IL>Approve</IL> - <IL>Approve, Abort</IL> - <IL>Approve, Disapprove</IL> - <IL>Approve, Disapprove, Abort</IL> + <LI>Abort</LI> + <LI>Retry, Abort</LI> + <LI>Approve</LI> + <LI>Approve, Abort</LI> + <LI>Approve, Disapprove</LI> + <LI>Approve, Disapprove, Abort</LI> </UL></P> - <P>A <type>com::sun::star::ucb::InteractiveAugmentedIOException</type> + <P>An + <type scope="com::sun::star::ucb">InteractiveAugmentedIOException</type> carries with it a sequence of arguments, which should be - <type>com::sun::star::beans::PropertyValue</type>s. The following details - which properties are interpreted by the interaction handler, depending on - the request's <type>com::sun::star::ucb::IOErrorCode</type>: + <type scope="com::sun::star::beans">PropertyValue</type>s. The following + details which properties are interpreted by the interaction handler, + depending on the request's + <type scope="com::sun::star::ucb">IOErrorCode</type>: <DL> <DT><code>"Uri"</code></DT> - <DD>All error codes except <const>DIFFERENT_DEVICES</const>. The URI - of the involved resource (a <atom>string</atom>).</DD> + <DD>All error codes except + <const scope="com::sun::star::ucb">IOErrorCode::DIFFERENT_DEVICES</const>. + The URI of the involved resource (a <atom>string</atom>).</DD> <DT><code>"ResourceName"</code></DT> - <DD>All error codes except <const>DIFFERENT_DEVICES</const>. A name - for the involved resource (a <atom>string</atom>) that might be more - meaningful to the user than the URI. For example, a + <DD>All error codes except + <const scope="com::sun::star::ucb">IOErrorCode::DIFFERENT_DEVICES</const>. + A name for the involved resource (a <atom>string</atom>) that might be + more meaningful to the user than the URI. For example, a (platform-dependent) path notation for file system resources.</DD> <DT><code>"ResourceType"</code></DT> - <DD><const>DEVICE_NOT_READY</const> and <const>NOT_EXISTING</const> + <DD><const scope="com::sun::star::ucb">IOErrorCode::DEVICE_NOT_READY</const> + and + <const scope="com::sun::star::ucb">IOErrorCode::NOT_EXISTING</const> only. An identifier for the type of resource involved (a <atom>string</atom>). Currently understood values are <code>"volume"</code> (e.g., a file system volume) and @@ -140,17 +149,19 @@ module com { module sun { module star { module task { resources).</DD> <DT><code>"Removable"</code></DT> - <DD><const>NOT_EXISTING</const> only. A flag indicating whether the - resource resides on a storage medium that can be removed by the user - (a <atom>boolean</atom>).</DD> + <DD><const scope="com::sun::star::ucb">IOErrorCode::NOT_EXISTING</const> + only. A flag indicating whether the resource resides on a storage + medium that can be removed by the user (a <atom>boolean</atom>).</DD> <DT><code>"Folder"</code></DT> - <DD><const>CANT_CREATE</const>only. The name of the foler in which a - resource cannot be created (a <atom>string</atom>).</DD> + <DD><const scope="com::sun::star::ucb">IOErrorCode::CANT_CREATE</const> + only. The name of the foler in which a resource cannot be created (a + <atom>string</atom>).</DD> <DT><code>"Volume"</code> and <code>"OtherVolume"</code></DT> - <DD><const>DIFFERENT_DEVICES</const> only. The names of the two - volumes involved (two <atom>string</atom>s).</DD> + <DD><const scope="com::sun::star::ucb">IOErrorCode::DIFFERENT_DEVICES</const> + only. The names of the two volumes involved (two + <atom>string</atom>s).</DD> </DL></P> */ service InteractionHandler @@ -163,18 +174,18 @@ service InteractionHandler //------------------------------------------------------------------------ /** Initialize the interaction handler. - <p>The arguments must be a sequence of - <type>com::sun::star::beans::PropertyValue</type>s. The currently - supported properties are: - <ul> - <li><code>"Parent"</code> of type - <type>com::sun::star::awt::XWindow</type> denotes the parent - window for any GUI dialogs the interaction handler pops up; it is - strongly recommended that this property is supplied;</li> - <li><code>"Context"</code> of type <atom>string</atom> is a textual - description of the current context (used, e.g., as a first line of - text in error boxes); this property is optional.</li> - </ul></p> + <P>The arguments must be a sequence of + <type scope="com::sun::star::beans">PropertyValue</type>s. The + currently supported properties are: + <UL> + <LI><code>"Parent"</code> of type + <type scope="com::sun::star::awt">XWindow</type> denotes the + parent window for any GUI dialogs the interaction handler pops up; + it is strongly recommended that this property is supplied;</LI> + <LI><code>"Context"</code> of type <atom>string</atom> is a + textual description of the current context (used, e.g., as a first + line of text in error boxes); this property is optional.</LI> + </UL></P> */ interface com::sun::star::lang::XInitialization; }; diff --git a/offapi/com/sun/star/task/JobExecutor.idl b/offapi/com/sun/star/task/JobExecutor.idl index 4b2794122..9b51c9477 100644 --- a/offapi/com/sun/star/task/JobExecutor.idl +++ b/offapi/com/sun/star/task/JobExecutor.idl @@ -2,9 +2,9 @@ * * $RCSfile: JobExecutor.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: as $ $Date: 2001-12-05 13:18:25 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:52 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -66,12 +66,44 @@ #include <com/sun/star/task/XJobExecutor.idl> #endif +//============================================================================ + 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. + own configuration and there lifetime. Such events are simple strings + wich meaning doesn't matter for any real service implementation of this + specification. But triggered events must be available inside the + configuration and some <type>Job</type>s must be registered for that. + It's possible to start it synchronously (<type>XJob</type>) or asynchronously + (<type>XAsyncJob</type>). But in general it's forbidden to use any UI inside + synchronous one. That can be the source of many trouble and will be forbidden. + </p> + + <p> + A neccessary configuration of such job executor must support follow functionality: + <ul> + <li>Same Job should be able to register for more then one event</li> + <li>It must be possible to provide a place for job specific configuration data, + so the jobs doesn't be forced to use her own config implementation. + That's neccessary to perform whole operation because most possible events + can be occure during startup of an application. And configuration access + shouldn't make it slow. And one part of job interfaces is initialization + of it with her own config data.</li> + <li>It must be possible to configure if a job wish to be started synchronous + or not.</li> + </ul> + </p> + + <p> + Further it must be possible to deregister a successfully runned job. + </p> + + @see Job */ service JobExecutor { diff --git a/offapi/com/sun/star/task/NoMasterException.idl b/offapi/com/sun/star/task/NoMasterException.idl index 5acec8361..c30911bce 100644 --- a/offapi/com/sun/star/task/NoMasterException.idl +++ b/offapi/com/sun/star/task/NoMasterException.idl @@ -2,9 +2,9 @@ * * $RCSfile: NoMasterException.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: mav $ $Date: 2001-06-26 13:26:54 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:52 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,10 +75,12 @@ module com { module sun { module star { module task { //============================================================================= +/** is thrown when a master password is needed but not available/correct. + */ exception NoMasterException: com::sun::star::uno::RuntimeException { //------------------------------------------------------------------------- - /** Specifies the mode in which password should be asked + /** specifies the mode in which password should be queried. */ PasswordRequestMode Mode; diff --git a/offapi/com/sun/star/task/PasswordContainer.idl b/offapi/com/sun/star/task/PasswordContainer.idl new file mode 100644 index 000000000..b276cba88 --- /dev/null +++ b/offapi/com/sun/star/task/PasswordContainer.idl @@ -0,0 +1,114 @@ +/************************************************************************* + * + * $RCSfile: PasswordContainer.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: mi $ $Date: 2002-10-03 13:09:53 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#ifndef __com_sun_star_task_PasswordContainer_idl__ +#define __com_sun_star_task_PasswordContainer_idl__ + +module com { module sun { module star { + module task { interface XPasswordContainer; }; +}; }; }; + +module com { module sun { module star { module task { +//============================================================================ +/** this service is kind of storage that allows to store passwords + and to retrieve already stored. + + <P> + A password can be stored for the session period or persistently. + The persistent way is only possible if configuration allows to use storage. + It stores passwords encripted with a super password. An interaction + is used to ask a user for a super password. + To allow such an interaction, an object that implements <type>XInteractionHandler</type> + interface should be provided. For this purpose <type>InteractionHandler</type> + service can be used. + </P> + + <P> + In case no interaction handler is provided all passwords are stored + for the session period. In case an interaction handler is provided, but + the super password interaction does not return super password ( for any reason ), + <type>NoMasterException</type> exception is thrown to let user use + nonpersistent way explicitly. + </P> +*/ +service PasswordContainer +{ + //------------------------------------------------------------------------ + /** handles passwords + + <P> + Use this interface to store\retrieve passwords. + </P> + */ + interface com::sun::star::task::XPasswordContainer; + +}; + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.2.1 2002/03/21 16:48:34 mav + #98235# documentation review + + +=============================================================================*/ +#endif diff --git a/offapi/com/sun/star/task/PasswordRequest.idl b/offapi/com/sun/star/task/PasswordRequest.idl index 155b2613c..867a29e23 100644 --- a/offapi/com/sun/star/task/PasswordRequest.idl +++ b/offapi/com/sun/star/task/PasswordRequest.idl @@ -2,9 +2,9 @@ * * $RCSfile: PasswordRequest.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: mav $ $Date: 2001-06-26 13:26:54 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:53 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -75,10 +75,20 @@ module com { module sun { module star { module task { //============================================================================= +/** this request specifies the mode in wich the password should be asked + + <P> + It is supported by <type>InteractionHandler</type> service, and can + be used to interact for a password. Continuations for using with + the mentioned service are Abort and Approve. + </P> +*/ exception PasswordRequest: ClassifiedInteractionRequest { //------------------------------------------------------------------------- - /** Specifies the mode in which password should be asked + /** the mode in which password should be asked + + @see com::sun::star::task::PasswordRequestMode */ PasswordRequestMode Mode; diff --git a/offapi/com/sun/star/task/PasswordRequestMode.idl b/offapi/com/sun/star/task/PasswordRequestMode.idl index 9ad475941..02691bdba 100644 --- a/offapi/com/sun/star/task/PasswordRequestMode.idl +++ b/offapi/com/sun/star/task/PasswordRequestMode.idl @@ -2,9 +2,9 @@ * * $RCSfile: PasswordRequestMode.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: mav $ $Date: 2001-06-26 13:26:54 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:53 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -72,18 +72,32 @@ enum PasswordRequestMode //------------------------------------------------------------------------- /** Password creation. + + <P> + The password is asked for the first time, + so it should be entered twice. + </P> */ PASSWORD_CREATE, //------------------------------------------------------------------------- - /** Ask for a password first time. + /** Ask for a password. + + <P> + Just ask for a password. + </P> */ PASSWORD_ENTER, //------------------------------------------------------------------------- /** Wrong password was entered, ask again. + + <P> + A wrong password was entered, notify user + and ask again. + </P> */ PASSWORD_REENTER diff --git a/offapi/com/sun/star/task/UrlRecord.idl b/offapi/com/sun/star/task/UrlRecord.idl index e0a3d0f5e..7e3a9d6fb 100644 --- a/offapi/com/sun/star/task/UrlRecord.idl +++ b/offapi/com/sun/star/task/UrlRecord.idl @@ -2,9 +2,9 @@ * * $RCSfile: UrlRecord.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: mav $ $Date: 2001-05-02 15:03:31 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:54 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -70,11 +70,14 @@ module com { module sun { module star { module task { //============================================================================= -/* List of users with there passwords for the url pattern +/* List of users with their passwords for the url pattern. */ struct UrlRecord { + /// The URL for which these passwords where given. string Url; + + // The list of user/password records for the given URL. sequence<UserRecord> UserList; }; diff --git a/offapi/com/sun/star/task/UserRecord.idl b/offapi/com/sun/star/task/UserRecord.idl index 5faa5d9c1..648c0d9a1 100644 --- a/offapi/com/sun/star/task/UserRecord.idl +++ b/offapi/com/sun/star/task/UserRecord.idl @@ -2,9 +2,9 @@ * * $RCSfile: UserRecord.idl,v $ * - * $Revision: 1.1 $ + * $Revision: 1.2 $ * - * last change: $Author: mav $ $Date: 2001-05-02 15:04:18 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:54 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -66,11 +66,14 @@ module com { module sun { module star { module task { //============================================================================= -/* Users passwords list +/* Specifies user/password entries for <type>UrlRecord</type>. */ struct UserRecord { + /// specifies the user name. string UserName; + + /// specifies the passwords for the given user. sequence<string> Passwords; }; diff --git a/offapi/com/sun/star/task/XAsyncJob.idl b/offapi/com/sun/star/task/XAsyncJob.idl index af52ddd81..59cc67042 100644 --- a/offapi/com/sun/star/task/XAsyncJob.idl +++ b/offapi/com/sun/star/task/XAsyncJob.idl @@ -2,9 +2,9 @@ * * $RCSfile: XAsyncJob.idl,v $ * - * $Revision: 1.3 $ + * $Revision: 1.4 $ * - * last change: $Author: vg $ $Date: 2002-04-30 12:49:12 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:55 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,48 +74,52 @@ #include <com/sun/star/lang/IllegalArgumentException.idl> #endif -//............................................................................. +//============================================================================= + module com { module sun { module star { module task { -//............................................................................. interface XJobListener; -/** specifies a job which is to be executed asynchronously. +//============================================================================= +/** specifies a job which is to be executed asynchronously + + <p> + Instead of <type>XJob</type> the implementation of this interface + must make shure that execution will be real asynchronous (e.g. by using + threads). Because it's not part of the generic <type>JobExecutor</type>, + the asynchronous mode must be guaranteed by the implementation of THIS + interface. + </p> + + @see XJob */ interface XAsyncJob : com::sun::star::uno::XInterface { + //------------------------------------------------------------------------ /** executes the job asynchronously - @param lArgs - 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). - @param xListener - specifies a listener which should be notified on events. May be <NULL/>. + + @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 <type>JobExecutor</type> + which use this asynchronous job. It's possible to write it back by called listener + function <member>XJobListener::jobFinished()</member> which must be the executor himself. + + @param Listener + specifies a listener which should be notified on events. May be <NULL/>. + If it's not <NULL/> it must be the <type>JobExecutor</type> which force this action. + + @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 */ - void executeAsync( [in] sequence< com::sun::star::beans::NamedValue > lArgs , - [in] XJobListener xListener ) raises( com::sun::star::lang::IllegalArgumentException ); + void executeAsync( + [in] sequence< com::sun::star::beans::NamedValue > Arguments, + [in] XJobListener Listener) + raises( com::sun::star::lang::IllegalArgumentException ); }; -//............................................................................. }; }; }; }; -//............................................................................. #endif -/************************************************************************* - * history: - * $Log: not supported by cvs2svn $ - * Revision 1.2 2001/12/05 13:18:25 as - * #91062# simple revision of job execution interfaces - * - * - * Revision 1.2 2001/11/20 14:28:26 as - * #91062# make interface more simple! - * - * Revision 1.1 2001/09/14 09:48:03 fs - * initial checkin - specification for a job to be executed asynchronously - * - * - * Revision 1.0 13.09.01 17:03:45 fs - ************************************************************************/ - diff --git a/offapi/com/sun/star/task/XJob.idl b/offapi/com/sun/star/task/XJob.idl index cea00d158..bad7df295 100644 --- a/offapi/com/sun/star/task/XJob.idl +++ b/offapi/com/sun/star/task/XJob.idl @@ -2,9 +2,9 @@ * * $RCSfile: XJob.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: vg $ $Date: 2002-04-30 12:49:12 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:57 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,49 +74,59 @@ #include <com/sun/star/lang/IllegalArgumentException.idl> #endif -//............................................................................. +//============================================================================ + module com { module sun { module star { module task { -//............................................................................. -/** specifies a simply synchronous job +//============================================================================= +/** specifies a job which is to be executed synchronously + + <p> + Instead of <type>XAsyncJob</type> 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. + </p> + + @see XAsyncJob */ interface XJob : com::sun::star::uno::XInterface { - /** executes the job - @param lArgs - 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). - @return - the result of the job. The concrete semantics is service-dependent. + //------------------------------------------------------------------------ + /** executes the job synchronously + + @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 <type>JobExecutor</type> + which use this synchronous job. It's possible to write it back by use special protocol + in return value. + + @return + the result of the job. The concrete semantics is service-dependent. + But it should be possible to + <ul> + <li>deregister the job</li> + <li>let him registered although execution was successfully(!)</li> + <li>make some job specific data persistent inside the job configuration which + is provided by the executor.</li> + </ul> + + @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. */ - any execute( [in] sequence< com::sun::star::beans::NamedValue > lArgs ) raises( com::sun::star::lang::IllegalArgumentException , - com::sun::star::uno::Exception ); + any execute( + [in] sequence< com::sun::star::beans::NamedValue > Arguments ) + raises( com::sun::star::lang::IllegalArgumentException , + com::sun::star::uno::Exception ); }; -//............................................................................. }; }; }; }; -//............................................................................. #endif - -/************************************************************************* - * history: - * $Log: not supported by cvs2svn $ - * Revision 1.3 2001/12/05 13:18:25 as - * #91062# simple revision of job execution interfaces - * - * - * Revision 1.3 2001/11/20 14:24:11 as - * #91062# make interface more simple! - * - * Revision 1.2 2001/09/25 14:14:45 fs - * #91062# introduce a result (return value of execute) / allow to throw any exceptions - * - * Revision 1.1 2001/09/14 09:47:49 fs - * initial checkin - specification for a simple executable job - * - * - * Revision 1.0 13.09.01 17:03:45 fs - ************************************************************************/ - diff --git a/offapi/com/sun/star/task/XJobExecutor.idl b/offapi/com/sun/star/task/XJobExecutor.idl index 54a24efbe..f6cb5aac7 100644 --- a/offapi/com/sun/star/task/XJobExecutor.idl +++ b/offapi/com/sun/star/task/XJobExecutor.idl @@ -2,9 +2,9 @@ * * $RCSfile: XJobExecutor.idl,v $ * - * $Revision: 1.2 $ + * $Revision: 1.3 $ * - * last change: $Author: vg $ $Date: 2002-04-30 12:49:12 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:57 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -66,36 +66,43 @@ #include <com/sun/star/uno/XInterface.idl> #endif -//............................................................................. +//============================================================================= + module com { module sun { module star { module task { -//............................................................................. +//============================================================================= +/** starts action for any triggered event from outside + + <p> + If somewhere from outside trigger an event on this interface + it will be used to find any registered service inside configuration + of this executor. If somewhere could be found it will be + started and controlled by this instance. After it finish his work + it's possible to deactivate further startups or let him run again if + a new event will be detected later. + </p> + + @see JobExecutor + */ interface XJobExecutor : com::sun::star::uno::XInterface { + //------------------------------------------------------------------------- /** trigger event to start registered jobs + + <p> Jobs are registered in configuration and will be started by executor automaticly, if they are registered for triggered event. + The meaning of given string <var>Event</var> mustn't be known. Because + for the executor it's enough to use it for searching a registered job + inside his own configuration. So no special events will be defined here. + </p> + + @param Event + describe the event for which jobs can be registered and should be started */ - [oneway] void trigger( [in] string sEvent ); + [oneway] void trigger( [in] string Event ); }; -//............................................................................. }; }; }; }; -//............................................................................. #endif - -/************************************************************************* - * history: - * $Log: not supported by cvs2svn $ - * Revision 1.1 2001/12/05 13:18:25 as - * #91062# simple revision of job execution interfaces - * - * - * Revision 1.1 20.11.2001 14:35 as - * initial checkin - specification for a job executor - * - * - * Revision 1.0 20.11.2001 14:35 as - ************************************************************************/ - diff --git a/offapi/com/sun/star/task/XJobListener.idl b/offapi/com/sun/star/task/XJobListener.idl index 969a8d979..3a72b9fa9 100644 --- a/offapi/com/sun/star/task/XJobListener.idl +++ b/offapi/com/sun/star/task/XJobListener.idl @@ -2,9 +2,9 @@ * * $RCSfile: XJobListener.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: vg $ $Date: 2002-04-30 12:49:12 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:57 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -66,48 +66,42 @@ #include <com/sun/star/lang/XEventListener.idl> #endif -//............................................................................. +//============================================================================= + module com { module sun { module star { module task { -//............................................................................. interface XAsyncJob; +//============================================================================= +/** listener on finish states of asynchronous job execution + */ interface XJobListener : com::sun::star::lang::XEventListener { - /** indicates that the job is done. - aResult should be the same like for the synchronous mode on XJob::execute() - and depends from service specification. + //------------------------------------------------------------------------ + /** indicates that the job is done + + @param Job + identifies the asynchronous job so the <type>JobExecutor</type> + can differ between more then ones. + + @param Result + should be the same like for the synchronous mode on <member>XJob::execute()</member>. + It provides information about success or failure of job execution. It's possible too, + to use special protocol (which depends from real implementation) between + <type>JobExecutor</type> and a real job. So it can be possible to: + + <ul> + <li>deregister the job</li> + <li>let him registered although execution was successfully(!)</li> + <li>make some job specific data persistent inside the job configuration which + is provided by the executor.</li> + </ul> */ - void jobFinished( [in] XAsyncJob xJob , - [in] any aResult ); + void jobFinished( + [in] XAsyncJob Job, + [in] any Result); }; -//............................................................................. }; }; }; }; -//............................................................................. #endif - -/************************************************************************* - * history: - * $Log: not supported by cvs2svn $ - * Revision 1.4 2001/12/05 13:18:25 as - * #91062# simple revision of job execution interfaces - * - * - * Revision 1.4 2001/11/20 14:30 as - * #91062# make it more simple! - * - * Revision 1.3 2001/09/26 16:16:17 fs - * #91062# corrected a comment - * - * Revision 1.2 2001/09/25 14:15:44 fs - * #91062# jobCancelled renamed to jobAborted / jobDone gets a new param (the result) - * - * Revision 1.1 2001/09/14 09:48:16 fs - * initial checkin - specification for a listener to an asynchronous job - * - * - * Revision 1.0 13.09.01 17:03:45 fs - ************************************************************************/ - diff --git a/offapi/com/sun/star/task/XStatusIndicator.idl b/offapi/com/sun/star/task/XStatusIndicator.idl index 34834522a..eb29dd336 100644 --- a/offapi/com/sun/star/task/XStatusIndicator.idl +++ b/offapi/com/sun/star/task/XStatusIndicator.idl @@ -2,9 +2,9 @@ * * $RCSfile: XStatusIndicator.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:57 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,86 +58,107 @@ * * ************************************************************************/ -#ifndef __com_sun_star_task_XStatusIndicator_idl__ -#define __com_sun_star_task_XStatusIndicator_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module task { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::task::XStatusIndicator +#ifndef __com_sun_star_task_XStatusIndicator_idl__ +#define __com_sun_star_task_XStatusIndicator_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +//============================================================================= + + module com { module sun { module star { module task { + +//============================================================================= /** controls a status indicator which displays progress of - longer actions to the user.@see XStatusIndicatorSupplier + longer actions to the user + + <p> + Such objects are provided by a <type>XStatusIndicatorFactory</type>. + </p> + + @see XStatusIndicatorFactory */ interface XStatusIndicator: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::task::XStatusIndicator::start - /** TODO +{ + //------------------------------------------------------------------------- + /** initialize and start the progress + + <p> + It activates a new created or reactivate an already used inidicator + (must be finished by calling <member>XStatusIndicator::end()</member> + before!). By the way it's possible to set first progress description + and the possible range of progress value. That means that a progress + can runs from 0 to <var>Range</var>. + </p> + + @param Text + initial value for progress description for showing + Value can be updated by calling <member>XStatusIndicator::setText()</member>. + + @param Range + mewns the maximum value of the progress which can be setted by + calling <member>XStatusIndicator::setValue()</member>. */ - [oneway] void start( [in] string aText, - [in] long nRange ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::task::XStatusIndicator::end - /** TODO + [oneway] void start( + [in] string Text, + [in] long Range); + + //------------------------------------------------------------------------- + /** stop the progress + + <p> + Further calls of <member>XStatusIndicator::setText()</member>, + <member>XStatusIndicator::setValue()</member> or + <member>XStatusIndicator::reset()</member> must be ignored. + Only <member>XStatusIndicator::start()</member> can reactivate this + indicator. + It's not allowed to destruct the indicator inside this method. + The instance must be gone by using ref count or disposing. + </p> */ - [oneway] void end(); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::task::XStatusIndicator::setText - /** TODO + [oneway] void end(); + + //------------------------------------------------------------------------- + /** update progress description + + <p> + Initial value can be set during starting of the progress by calling + <member>XStatusIndicator::start()</member>. + Stopped indicators must ignore this call. + </p> + + @param Text + new value for progress description which should be shown now */ - [oneway] void setText( [in] string aText ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::task::XStatusIndicator::setValue - /** TODO + [oneway] void setText( [in] string Text ); + + //------------------------------------------------------------------------- + /** update progress value + + <p> + Wrong values must be ignored and stopped indicators must ignore this + call generaly. + </p> + + @param Value + new value for progress which should be shown now + Must fit the range [0..Range] which was set during + <member>XStatusIndicator::start()</member>. */ - [oneway] void setValue( [in] long nValue ); - - //------------------------------------------------------------------------- - - // DocMerge from xml: method com::sun::star::task::XStatusIndicator::reset - /** TODO + [oneway] void setValue( [in] long Value ); + + //------------------------------------------------------------------------- + /** clear progress value and description + + <p> + Calling of setValue(0) and setText("") should do the same. + Stopped indicators must ignore this call. + </p> */ - [oneway] void reset(); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:20 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:44:23 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:57 hjs - initial import - - Revision 1.3 2000/09/11 11:52:58 mi - documentation merged from XML - - Revision 1.1.1.1 1999/11/11 09:48:46 jsc - new - - -=============================================================================*/ -#endif + [oneway] void reset(); +}; + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/task/XStatusIndicatorFactory.idl b/offapi/com/sun/star/task/XStatusIndicatorFactory.idl index 58bdbd1ef..c3e4f58ef 100644 --- a/offapi/com/sun/star/task/XStatusIndicatorFactory.idl +++ b/offapi/com/sun/star/task/XStatusIndicatorFactory.idl @@ -2,9 +2,9 @@ * * $RCSfile: XStatusIndicatorFactory.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:57 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,62 +58,42 @@ * * ************************************************************************/ -#ifndef __com_sun_star_task_XStatusIndicatorFactory_idl__ -#define __com_sun_star_task_XStatusIndicatorFactory_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_task_XStatusIndicator_idl__ -#include <com/sun/star/task/XStatusIndicator.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module task { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::task::XStatusIndicatorFactory -/** provides multiple, probably parallel running, status indicator objects.@see Frame +#ifndef __com_sun_star_task_XStatusIndicatorFactory_idl__ +#define __com_sun_star_task_XStatusIndicatorFactory_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_task_XStatusIndicator_idl__ +#include <com/sun/star/task/XStatusIndicator.idl> +#endif + +//============================================================================= + + module com { module sun { module star { module task { + +//============================================================================= +/** provides multiple, probably parallel running, status indicator objects + + <p> + A possible factory is the <type scope="com::sun::star::frame">Frame</type> + service. + </p> + + @see com::sun::star::frame::Frame */ interface XStatusIndicatorFactory: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - // DOCUMENTATION MISSING FOR XStatusIndicatorFactory::createStatusIndicator - - // DocMerge: empty anyway - com::sun::star::task::XStatusIndicator createStatusIndicator(); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.4 2000/12/21 08:35:20 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.3 2000/11/08 12:44:23 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:56 hjs - initial import - - Revision 1.4 2000/09/11 11:52:58 mi - documentation merged from XML - - Revision 1.2 2000/02/07 11:24:59 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:46 jsc - new - - -=============================================================================*/ -#endif +{ + //------------------------------------------------------------------------- + /** create a new status indicator instance + + @returns + the new indicator + */ + com::sun::star::task::XStatusIndicator createStatusIndicator(); +}; + +}; }; }; }; + +#endif diff --git a/offapi/com/sun/star/task/XStatusIndicatorSupplier.idl b/offapi/com/sun/star/task/XStatusIndicatorSupplier.idl index 11ec24ec2..14bf5c274 100644 --- a/offapi/com/sun/star/task/XStatusIndicatorSupplier.idl +++ b/offapi/com/sun/star/task/XStatusIndicatorSupplier.idl @@ -2,9 +2,9 @@ * * $RCSfile: XStatusIndicatorSupplier.idl,v $ * - * $Revision: 1.4 $ + * $Revision: 1.5 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:45 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:09:58 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -58,73 +58,38 @@ * * ************************************************************************/ -#ifndef __com_sun_star_task_XStatusIndicatorSupplier_idl__ -#define __com_sun_star_task_XStatusIndicatorSupplier_idl__ - -#ifndef __com_sun_star_uno_XInterface_idl__ -#include <com/sun/star/uno/XInterface.idl> -#endif - -#ifndef __com_sun_star_task_XStatusIndicator_idl__ -#include <com/sun/star/task/XStatusIndicator.idl> -#endif - - -//============================================================================= - - module com { module sun { module star { module task { - -//============================================================================= - -// DocMerge from xml: interface com::sun::star::task::XStatusIndicatorSupplier -/** gives access to a status indicator interface. - - - - - - - - - - - - - +#ifndef __com_sun_star_task_XStatusIndicatorSupplier_idl__ +#define __com_sun_star_task_XStatusIndicatorSupplier_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_task_XStatusIndicator_idl__ +#include <com/sun/star/task/XStatusIndicator.idl> +#endif + + +//============================================================================= + + module com { module sun { module star { module task { + +//============================================================================= +/** use <type>XStatusIndicatorFactory</type> instead of this + @deprecated */ interface XStatusIndicatorSupplier: com::sun::star::uno::XInterface -{ - //------------------------------------------------------------------------- - // DOCUMENTATION MISSING FOR XStatusIndicatorSupplier::getStatusIndicator - - // DocMerge: empty anyway - com::sun::star::task::XStatusIndicator getStatusIndicator(); - -}; - -//============================================================================= - -}; }; }; }; - -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.3 2000/11/08 12:44:23 mi - moved from api - - Revision 1.1.1.1 2000/09/18 23:35:57 hjs - initial import - - Revision 1.4 2000/09/11 11:52:58 mi - documentation merged from XML - - Revision 1.2 2000/02/07 11:24:59 mi - zu #70728# missing documentation marked - - Revision 1.1.1.1 1999/11/11 09:48:46 jsc - new - - -=============================================================================*/ -#endif +{ + //------------------------------------------------------------------------- + /** use <member>XStatusIndicatorFactory::createStatusIndicator()</member> + instead of this + + @deprecated + */ + com::sun::star::task::XStatusIndicator getStatusIndicator(); +}; + +}; }; }; }; + +#endif |