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