1d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5d1766043SAndrew Rist * distributed with this work for additional information 6d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10d1766043SAndrew Rist * 11d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12d1766043SAndrew Rist * 13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14d1766043SAndrew Rist * software distributed under the License is distributed on an 15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17d1766043SAndrew Rist * specific language governing permissions and limitations 18d1766043SAndrew Rist * under the License. 19d1766043SAndrew Rist * 20d1766043SAndrew Rist *************************************************************/ 21d1766043SAndrew Rist 22d1766043SAndrew Rist 23cdf0e10cSrcweir 24cdf0e10cSrcweir#ifndef __com_sun_star_setup_ProductRegistration_idl__ 25cdf0e10cSrcweir#define __com_sun_star_setup_ProductRegistration_idl__ 26cdf0e10cSrcweir 27cdf0e10cSrcweir#ifndef __com_sun_star_task_JobExecutor_idl__ 28cdf0e10cSrcweir#include <com/sun/star/task/JobExecutor.idl> 29cdf0e10cSrcweir#endif 30cdf0e10cSrcweir 31cdf0e10cSrcweir#ifndef __com_sun_star_task_XJob_idl__ 32cdf0e10cSrcweir#include <com/sun/star/task/XJob.idl> 33cdf0e10cSrcweir#endif 34cdf0e10cSrcweir 35cdf0e10cSrcweirmodule com { module sun { module star { module setup { 36cdf0e10cSrcweir 37cdf0e10cSrcweir/** provides a mechanism for registering the product. 38cdf0e10cSrcweir 39cdf0e10cSrcweir <p>Two main functionalities are covered by this service: 40cdf0e10cSrcweir <ul><il><em>Triggering Online Registration</em><br/> 41cdf0e10cSrcweir If, by any user interface of your choice, the user tells she wants to register 42cdf0e10cSrcweir their product copy, ProductRegistration is the service of your choice. 43cdf0e10cSrcweir </il><br/> 44cdf0e10cSrcweir <il><em>Executing Registration Requests</em><br/> 45cdf0e10cSrcweir ProductRegistration allows to remind your users to register, using a dialog with various 46cdf0e10cSrcweir choices. 47cdf0e10cSrcweir </il> 48cdf0e10cSrcweir </ul></p> 49cdf0e10cSrcweir 50*96af39f7SJürgen Schmidt @since OpenOffice 1.1.2 51cdf0e10cSrcweir*/ 52cdf0e10cSrcweirpublished service ProductRegistration 53cdf0e10cSrcweir{ 54cdf0e10cSrcweir /** allows to trigger certain events. 55cdf0e10cSrcweir 56cdf0e10cSrcweir <p>The string argument of <method scope="com::sun::star::task">XJobExecutor::trigger</method> is 57cdf0e10cSrcweir used to determine the type of the event. Currently supported events are:<br/> 58cdf0e10cSrcweir <ul><li><b>RegistrationRequired</b><br/> 59cdf0e10cSrcweir Determines that the registration is required to be executed.<br/> 60cdf0e10cSrcweir This is usually triggered by some user interaction, for instance upon choosing a menu item 61cdf0e10cSrcweir called <em>Registration</em>.</p> 62cdf0e10cSrcweir </li> 63cdf0e10cSrcweir </ul> 64cdf0e10cSrcweir </p> 65cdf0e10cSrcweir */ 66cdf0e10cSrcweir service com::sun::star::task::JobExecutor; 67cdf0e10cSrcweir 68cdf0e10cSrcweir /** allows the registration request to be scheduled automatically. 69cdf0e10cSrcweir 70cdf0e10cSrcweir <p>There are processes which allow to schedule events and jobs, for instance there 71cdf0e10cSrcweir can be configuration settings scheduling which operations are to be executed upon an program 72cdf0e10cSrcweir startup. Such processes usually require the jobs to be executed to support the 73cdf0e10cSrcweir <type scope="com::sun::star::task">XJob</type> interface.</p> 74cdf0e10cSrcweir 75cdf0e10cSrcweir <p>That's why this service supports the <type scope="com::sun::star::task">XJob</type>, too.<br/> 76cdf0e10cSrcweir Calling the <method scope="com::sun::star::task">XJob::execute</method> method results in displaying a 77cdf0e10cSrcweir dialog which asks the user to register. This is done once per session, means you need to restart the 78cdf0e10cSrcweir process which called this.</p> 79cdf0e10cSrcweir 80cdf0e10cSrcweir <p>At the moment, there is no specification about how to use the arguments given in the 81cdf0e10cSrcweir <method scope="com::sun::star::task">XJob::execute</method> method, but this may change in future versions of the service 82cdf0e10cSrcweir descriptions, so to keep your implementation compatible, you should not use these arguments.</p> 83cdf0e10cSrcweir */ 84cdf0e10cSrcweir interface com::sun::star::task::XJob; 85cdf0e10cSrcweir}; 86cdf0e10cSrcweir 87cdf0e10cSrcweir}; }; }; }; 88cdf0e10cSrcweir 89cdf0e10cSrcweir#endif 90