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

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