offapi/com/sun/star/setup/ProductRegistration.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: ProductRegistration.idl,v $
  10  * $Revision: 1.9 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_setup_ProductRegistration_idl__
  32 #define __com_sun_star_setup_ProductRegistration_idl__
  33
  34 #ifndef __com_sun_star_task_JobExecutor_idl__
  35 #include <com/sun/star/task/JobExecutor.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_task_XJob_idl__
  39 #include <com/sun/star/task/XJob.idl>
  40 #endif
  41
  42 module com {  module sun {  module star {  module setup {
  43
  44 /** provides a mechanism for registering the product.
  45
  46     <p>Two main functionalities are covered by this service:
  47     <ul><il><em>Triggering Online Registration</em><br/>
  48             If, by any user interface of your choice, the user tells she wants to register
  49             their product copy, ProductRegistration is the service of your choice.
  50         </il><br/>
  51         <il><em>Executing Registration Requests</em><br/>
  52             ProductRegistration allows to remind your users to register, using a dialog with various
  53             choices.
  54         </il>
  55     </ul></p>
  56
  57     @since OOo 1.1.2
  58 */
  59 published service ProductRegistration
  60 {
  61     /** allows to trigger certain events.
  62
  63         <p>The string argument of <method scope="com::sun::star::task">XJobExecutor::trigger</method> is
  64             used to determine the type of the event. Currently supported events are:<br/>
  65             <ul><li><b>RegistrationRequired</b><br/>
  66                     Determines that the registration is required to be executed.<br/>
  67                     This is usually triggered by some user interaction, for instance upon choosing a menu item
  68                     called <em>Registration</em>.</p>
  69                 </li>
  70             </ul>
  71         </p>
  72     */
  73     service com::sun::star::task::JobExecutor;
  74
  75     /** allows the registration request to be scheduled automatically.
  76
  77         <p>There are processes which allow to schedule events and jobs, for instance there
  78         can be configuration settings scheduling which operations are to be executed upon an program
  79         startup. Such processes usually require the jobs to be executed to support the
  80         <type scope="com::sun::star::task">XJob</type> interface.</p>
  81
  82         <p>That's why this service supports the <type scope="com::sun::star::task">XJob</type>, too.<br/>
  83         Calling the <method scope="com::sun::star::task">XJob::execute</method> method results in displaying a
  84         dialog which asks the user to register. This is done once per session, means you need to restart the
  85         process which called this.</p>
  86
  87         <p>At the moment, there is no specification about how to use the arguments given in the
  88         <method scope="com::sun::star::task">XJob::execute</method> method, but this may change in future versions of the service
  89         descriptions, so to keep your implementation compatible, you should not use these arguments.</p>
  90     */
  91     interface com::sun::star::task::XJob;
  92 };
  93
  94 }; }; }; };
  95
  96 #endif