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
  21 module com {  module sun {  module star {  module form { module submission {
  22
  23 interface XSubmissionVetoListener;
  24
  25
  26 /** is implemented by components which support submitting data.
  27 */
  28 interface XSubmission : com::sun::star::uno::XInterface
  29 {
  30     /** tells the component to submit data
  31
  32         @throws com::sun::star::util::VetoException
  33             if the submission has been vetoed. Usually, this indicates that not all
  34             requirements for the submission, e.g. data consistency, are fulfilled.
  35
  36         @throws com::sun::star::lang::WrappedTargetException
  37             if an error occurred during invoking the submission target
  38     */
  39     void submit( )
  40                 raises ( com::sun::star::util::VetoException, com::sun::star::lang::WrappedTargetException );
  41
  42     /** tells the component to submit data
  43
  44         @param aHandler
  45             This handler allows additional user interaction, which may be necessary before
  46             the submission can be performed.
  47
  48         @throws com::sun::star::util::VetoException
  49             if the submission has been vetoed. Usually, this indicates that not all
  50             requirements for the submission, e.g. data consistency, are fulfilled.
  51
  52         @throws com::sun::star::lang::WrappedTargetException
  53             if an error occurred during invoking the submission target
  54     */
  55     void submitWithInteraction( [in] com::sun::star::task::XInteractionHandler aHandler )
  56                 raises ( com::sun::star::util::VetoException, com::sun::star::lang::WrappedTargetException );
  57
  58     /** registers the given listener to be notified when a submission occurs
  59
  60         @param listener
  61             the listener to register
  62
  63         @throws com::sun::star::lang::NoSupportException
  64             when the component does not support external components vetoing the submission
  65      */
  66     void addSubmissionVetoListener( [in] XSubmissionVetoListener listener )
  67         raises ( com::sun::star::lang::NoSupportException );
  68
  69     /** revokes a listener which has previously been registered to be notified when a submission occurs
  70
  71         @param listener
  72             the listener to revoke
  73
  74         @throws com::sun::star::lang::NoSupportException
  75             when the component does not support external components vetoing the submission
  76      */
  77     void removeSubmissionVetoListener( [in] XSubmissionVetoListener listener )
  78         raises ( com::sun::star::lang::NoSupportException );
  79 };
  80
  81
  82 }; }; }; }; };
  83
  84 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */