offapi/com/sun/star/task/FutureDocumentVersionProductUpdateRequest.idl

   1 /*************************************************************************
   2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   3 *
   4 * Copyright 2008 by Sun Microsystems, Inc.
   5 *
   6 * OpenOffice.org - a multi-platform office productivity suite
   7 *
   8 * $RCSfile: FutureDocumentVersionProductUpdateRequest.idl,v $
   9 *
  10 * $Revision: 1.1.2.1 $
  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 #include <com/sun/star/task/ClassifiedInteractionRequest.idl>
  31
  32 #ifndef __com_sun_star_task_FutureDocumentVersionProductUpdateRequest_idl__
  33 #define __com_sun_star_task_FutureDocumentVersionProductUpdateRequest_idl__
  34
  35 //=============================================================================
  36
  37 module com { module sun { module star { module task {
  38
  39 //=============================================================================
  40
  41 /** describes a request to the user to update OpenOffice.org to a newer version, since
  42     an ODF document was encountered which conforms to an ODF version unknown to the
  43     current OpenOffice.org version.
  44
  45     <p>An interaction request of this type usually comes with an <type>XInteractionApprove</type>,
  46     and <type>XInteractionDisapprove</type>, and <type>XInteractionAskLater</type> continuation.</p>
  47  */
  48 exception FutureDocumentVersionProductUpdateRequest : ClassifiedInteractionRequest
  49 {
  50     /// specifies the URL of the document which conforms to a future ODF version
  51     string DocumentURL;
  52
  53     /** the ODF version which the document conforms to
  54
  55         <p>If the request was not issued because of a too-new ODF version of the document, but because
  56         the application detected by other means that the document was too-new, then <code>DocumentODFVersion</code>
  57         is allowed to be empty</p>
  58     */
  59     string DocumentODFVersion;
  60 };
  61
  62 //=============================================================================
  63
  64 }; }; }; };
  65
  66 //=============================================================================
  67
  68 #endif