1d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5d1766043SAndrew Rist * distributed with this work for additional information 6d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10d1766043SAndrew Rist * 11d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12d1766043SAndrew Rist * 13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14d1766043SAndrew Rist * software distributed under the License is distributed on an 15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17d1766043SAndrew Rist * specific language governing permissions and limitations 18d1766043SAndrew Rist * under the License. 19d1766043SAndrew Rist * 20d1766043SAndrew Rist *************************************************************/ 21d1766043SAndrew Rist 22d1766043SAndrew Rist 23cdf0e10cSrcweir 24cdf0e10cSrcweir#ifndef __com_sun_star_form_submission_XSubmission_idl__ 25cdf0e10cSrcweir#define __com_sun_star_form_submission_XSubmission_idl__ 26cdf0e10cSrcweir 27cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 28cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 29cdf0e10cSrcweir#endif 30cdf0e10cSrcweir#ifndef __com_sun_star_util_VetoException_idl__ 31cdf0e10cSrcweir#include <com/sun/star/util/VetoException.idl> 32cdf0e10cSrcweir#endif 33cdf0e10cSrcweir#ifndef __com_sun_star_lang_WrappedTargetException_idl__ 34cdf0e10cSrcweir#include <com/sun/star/lang/WrappedTargetException.idl> 35cdf0e10cSrcweir#endif 36cdf0e10cSrcweir#ifndef __com_sun_star_lang_NoSupportException_idl__ 37cdf0e10cSrcweir#include <com/sun/star/lang/NoSupportException.idl> 38cdf0e10cSrcweir#endif 39cdf0e10cSrcweir#ifndef __com_sun_star_task_XInteractionHandler_idl__ 40cdf0e10cSrcweir#include <com/sun/star/task/XInteractionHandler.idl> 41cdf0e10cSrcweir#endif 42cdf0e10cSrcweir 43cdf0e10cSrcweir//============================================================================= 44cdf0e10cSrcweir 45cdf0e10cSrcweirmodule com { module sun { module star { module form { module submission { 46cdf0e10cSrcweir 47cdf0e10cSrcweirinterface XSubmissionVetoListener; 48cdf0e10cSrcweir 49cdf0e10cSrcweir//============================================================================= 50cdf0e10cSrcweir 51cdf0e10cSrcweir/** is implemented by components which support submitting data. 52cdf0e10cSrcweir*/ 53cdf0e10cSrcweirinterface XSubmission : com::sun::star::uno::XInterface 54cdf0e10cSrcweir{ 55cdf0e10cSrcweir /** tells the component to submit data 56cdf0e10cSrcweir 57cdf0e10cSrcweir @throws com::sun::star::util::VetoException 58cdf0e10cSrcweir if the submission has been vetoed. Usually, this indicates that not all 59cdf0e10cSrcweir requirements for the submission, e.g. data consistency, are fulfilled. 60cdf0e10cSrcweir 61cdf0e10cSrcweir @throws com::sun::star::lang::WrappedTargetException 62*a893be29SPedro Giffuni if an error occurred during invoking the submission target 63cdf0e10cSrcweir */ 64cdf0e10cSrcweir void submit( ) 65cdf0e10cSrcweir raises ( com::sun::star::util::VetoException, com::sun::star::lang::WrappedTargetException ); 66cdf0e10cSrcweir 67cdf0e10cSrcweir /** tells the component to submit data 68cdf0e10cSrcweir 69cdf0e10cSrcweir @param aHandler 70cdf0e10cSrcweir This handler allows additional user interaction, which may be necessary before 71cdf0e10cSrcweir the submission can be performed. 72cdf0e10cSrcweir 73cdf0e10cSrcweir @throws com::sun::star::util::VetoException 74cdf0e10cSrcweir if the submission has been vetoed. Usually, this indicates that not all 75cdf0e10cSrcweir requirements for the submission, e.g. data consistency, are fulfilled. 76cdf0e10cSrcweir 77cdf0e10cSrcweir @throws com::sun::star::lang::WrappedTargetException 78*a893be29SPedro Giffuni if an error occurred during invoking the submission target 79cdf0e10cSrcweir */ 80cdf0e10cSrcweir void submitWithInteraction( [in] com::sun::star::task::XInteractionHandler aHandler ) 81cdf0e10cSrcweir raises ( com::sun::star::util::VetoException, com::sun::star::lang::WrappedTargetException ); 82cdf0e10cSrcweir 83cdf0e10cSrcweir /** registers the given listener to be notified when a submission occurs 84cdf0e10cSrcweir 85cdf0e10cSrcweir @param listener 86cdf0e10cSrcweir the listener to register 87cdf0e10cSrcweir 88cdf0e10cSrcweir @throws com::sun::star::lang::NoSupportException 89cdf0e10cSrcweir when the component does not support external componentsw vetoing the submission 90cdf0e10cSrcweir */ 91cdf0e10cSrcweir void addSubmissionVetoListener( [in] XSubmissionVetoListener listener ) 92cdf0e10cSrcweir raises ( com::sun::star::lang::NoSupportException ); 93cdf0e10cSrcweir 94cdf0e10cSrcweir /** revokes a listener which has previously been registered to be notified when a submission occurs 95cdf0e10cSrcweir 96cdf0e10cSrcweir @param listener 97cdf0e10cSrcweir the listener to revoke 98cdf0e10cSrcweir 99cdf0e10cSrcweir @throws com::sun::star::lang::NoSupportException 100cdf0e10cSrcweir when the component does not support external componentsw vetoing the submission 101cdf0e10cSrcweir */ 102cdf0e10cSrcweir void removeSubmissionVetoListener( [in] XSubmissionVetoListener listener ) 103cdf0e10cSrcweir raises ( com::sun::star::lang::NoSupportException ); 104cdf0e10cSrcweir}; 105cdf0e10cSrcweir 106cdf0e10cSrcweir//============================================================================= 107cdf0e10cSrcweir 108cdf0e10cSrcweir}; }; }; }; }; 109cdf0e10cSrcweir 110cdf0e10cSrcweir#endif 111