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 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XSubmission.idl,v $
  10  * $Revision: 1.4 $
  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
  31 #ifndef __com_sun_star_form_submission_XSubmission_idl__
  32 #define __com_sun_star_form_submission_XSubmission_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37 #ifndef __com_sun_star_util_VetoException_idl__
  38 #include <com/sun/star/util/VetoException.idl>
  39 #endif
  40 #ifndef __com_sun_star_lang_WrappedTargetException_idl__
  41 #include <com/sun/star/lang/WrappedTargetException.idl>
  42 #endif
  43 #ifndef __com_sun_star_lang_NoSupportException_idl__
  44 #include <com/sun/star/lang/NoSupportException.idl>
  45 #endif
  46 #ifndef __com_sun_star_task_XInteractionHandler_idl__
  47 #include <com/sun/star/task/XInteractionHandler.idl>
  48 #endif
  49
  50 //=============================================================================
  51
  52 module com {  module sun {  module star {  module form { module submission {
  53
  54 interface XSubmissionVetoListener;
  55
  56 //=============================================================================
  57
  58 /** is implemented by components which support submitting data.
  59 */
  60 interface XSubmission : com::sun::star::uno::XInterface
  61 {
  62     /** tells the component to submit data
  63
  64         @throws com::sun::star::util::VetoException
  65             if the submission has been vetoed. Usually, this indicates that not all
  66             requirements for the submission, e.g. data consistency, are fulfilled.
  67
  68         @throws com::sun::star::lang::WrappedTargetException
  69             if an error occured during invoking the submission target
  70     */
  71     void submit( )
  72                 raises ( com::sun::star::util::VetoException, com::sun::star::lang::WrappedTargetException );
  73
  74     /** tells the component to submit data
  75
  76         @param aHandler
  77             This handler allows additional user interaction, which may be necessary before
  78             the submission can be performed.
  79
  80         @throws com::sun::star::util::VetoException
  81             if the submission has been vetoed. Usually, this indicates that not all
  82             requirements for the submission, e.g. data consistency, are fulfilled.
  83
  84         @throws com::sun::star::lang::WrappedTargetException
  85             if an error occured during invoking the submission target
  86     */
  87     void submitWithInteraction( [in] com::sun::star::task::XInteractionHandler aHandler )
  88                 raises ( com::sun::star::util::VetoException, com::sun::star::lang::WrappedTargetException );
  89
  90     /** registers the given listener to be notified when a submission occurs
  91
  92         @param listener
  93             the listener to register
  94
  95         @throws com::sun::star::lang::NoSupportException
  96             when the component does not support external componentsw vetoing the submission
  97      */
  98     void addSubmissionVetoListener( [in] XSubmissionVetoListener listener )
  99         raises ( com::sun::star::lang::NoSupportException );
 100
 101     /** revokes a listener which has previously been registered to be notified when a submission occurs
 102
 103         @param listener
 104             the listener to revoke
 105
 106         @throws com::sun::star::lang::NoSupportException
 107             when the component does not support external componentsw vetoing the submission
 108      */
 109     void removeSubmissionVetoListener( [in] XSubmissionVetoListener listener )
 110         raises ( com::sun::star::lang::NoSupportException );
 111 };
 112
 113 //=============================================================================
 114
 115 }; }; }; }; };
 116
 117 #endif