offapi/com/sun/star/form/submission/XSubmission.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_form_submission_XSubmission_idl__
  21 #define __com_sun_star_form_submission_XSubmission_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/util/VetoException.idl>
  25 #include <com/sun/star/lang/WrappedTargetException.idl>
  26 #include <com/sun/star/lang/NoSupportException.idl>
  27 #include <com/sun/star/task/XInteractionHandler.idl>
  28
  29
  30 module com {  module sun {  module star {  module form { module submission {
  31
  32 interface XSubmissionVetoListener;
  33
  34
  35 /** is implemented by components which support submitting data.
  36 */
  37 interface XSubmission : com::sun::star::uno::XInterface
  38 {
  39     /** tells the component to submit data
  40
  41         @throws com::sun::star::util::VetoException
  42             if the submission has been vetoed. Usually, this indicates that not all
  43             requirements for the submission, e.g. data consistency, are fulfilled.
  44
  45         @throws com::sun::star::lang::WrappedTargetException
  46             if an error occurred during invoking the submission target
  47     */
  48     void submit( )
  49                 raises ( com::sun::star::util::VetoException, com::sun::star::lang::WrappedTargetException );
  50
  51     /** tells the component to submit data
  52
  53         @param aHandler
  54             This handler allows additional user interaction, which may be necessary before
  55             the submission can be performed.
  56
  57         @throws com::sun::star::util::VetoException
  58             if the submission has been vetoed. Usually, this indicates that not all
  59             requirements for the submission, e.g. data consistency, are fulfilled.
  60
  61         @throws com::sun::star::lang::WrappedTargetException
  62             if an error occurred during invoking the submission target
  63     */
  64     void submitWithInteraction( [in] com::sun::star::task::XInteractionHandler aHandler )
  65                 raises ( com::sun::star::util::VetoException, com::sun::star::lang::WrappedTargetException );
  66
  67     /** registers the given listener to be notified when a submission occurs
  68
  69         @param listener
  70             the listener to register
  71
  72         @throws com::sun::star::lang::NoSupportException
  73             when the component does not support external components vetoing the submission
  74      */
  75     void addSubmissionVetoListener( [in] XSubmissionVetoListener listener )
  76         raises ( com::sun::star::lang::NoSupportException );
  77
  78     /** revokes a listener which has previously been registered to be notified when a submission occurs
  79
  80         @param listener
  81             the listener to revoke
  82
  83         @throws com::sun::star::lang::NoSupportException
  84             when the component does not support external components vetoing the submission
  85      */
  86     void removeSubmissionVetoListener( [in] XSubmissionVetoListener listener )
  87         raises ( com::sun::star::lang::NoSupportException );
  88 };
  89
  90
  91 }; }; }; }; };
  92
  93 #endif
  94
  95 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */