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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_form_submission_XSubmission_idl__
  29 #define __com_sun_star_form_submission_XSubmission_idl__
  30
  31 #ifndef __com_sun_star_uno_XInterface_idl__
  32 #include <com/sun/star/uno/XInterface.idl>
  33 #endif
  34 #ifndef __com_sun_star_util_VetoException_idl__
  35 #include <com/sun/star/util/VetoException.idl>
  36 #endif
  37 #ifndef __com_sun_star_lang_WrappedTargetException_idl__
  38 #include <com/sun/star/lang/WrappedTargetException.idl>
  39 #endif
  40 #ifndef __com_sun_star_lang_NoSupportException_idl__
  41 #include <com/sun/star/lang/NoSupportException.idl>
  42 #endif
  43 #ifndef __com_sun_star_task_XInteractionHandler_idl__
  44 #include <com/sun/star/task/XInteractionHandler.idl>
  45 #endif
  46
  47 //=============================================================================
  48
  49 module com {  module sun {  module star {  module form { module submission {
  50
  51 interface XSubmissionVetoListener;
  52
  53 //=============================================================================
  54
  55 /** is implemented by components which support submitting data.
  56 */
  57 interface XSubmission : com::sun::star::uno::XInterface
  58 {
  59     /** tells the component to submit data
  60
  61         @throws com::sun::star::util::VetoException
  62             if the submission has been vetoed. Usually, this indicates that not all
  63             requirements for the submission, e.g. data consistency, are fulfilled.
  64
  65         @throws com::sun::star::lang::WrappedTargetException
  66             if an error occured during invoking the submission target
  67     */
  68     void submit( )
  69                 raises ( com::sun::star::util::VetoException, com::sun::star::lang::WrappedTargetException );
  70
  71     /** tells the component to submit data
  72
  73         @param aHandler
  74             This handler allows additional user interaction, which may be necessary before
  75             the submission can be performed.
  76
  77         @throws com::sun::star::util::VetoException
  78             if the submission has been vetoed. Usually, this indicates that not all
  79             requirements for the submission, e.g. data consistency, are fulfilled.
  80
  81         @throws com::sun::star::lang::WrappedTargetException
  82             if an error occured during invoking the submission target
  83     */
  84     void submitWithInteraction( [in] com::sun::star::task::XInteractionHandler aHandler )
  85                 raises ( com::sun::star::util::VetoException, com::sun::star::lang::WrappedTargetException );
  86
  87     /** registers the given listener to be notified when a submission occurs
  88
  89         @param listener
  90             the listener to register
  91
  92         @throws com::sun::star::lang::NoSupportException
  93             when the component does not support external componentsw vetoing the submission
  94      */
  95     void addSubmissionVetoListener( [in] XSubmissionVetoListener listener )
  96         raises ( com::sun::star::lang::NoSupportException );
  97
  98     /** revokes a listener which has previously been registered to be notified when a submission occurs
  99
 100         @param listener
 101             the listener to revoke
 102
 103         @throws com::sun::star::lang::NoSupportException
 104             when the component does not support external componentsw vetoing the submission
 105      */
 106     void removeSubmissionVetoListener( [in] XSubmissionVetoListener listener )
 107         raises ( com::sun::star::lang::NoSupportException );
 108 };
 109
 110 //=============================================================================
 111
 112 }; }; }; }; };
 113
 114 #endif