xref: /AOO41X/main/offapi/com/sun/star/sdb/XRowSetApproveListener.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
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#ifndef __com_sun_star_sdb_XRowSetApproveListener_idl__
24#define __com_sun_star_sdb_XRowSetApproveListener_idl__
25
26#ifndef __com_sun_star_lang_XEventListener_idl__
27#include <com/sun/star/lang/XEventListener.idl>
28#endif
29
30#ifndef __com_sun_star_sdb_RowChangeEvent_idl__
31#include <com/sun/star/sdb/RowChangeEvent.idl>
32#endif
33
34 module com {  module sun {  module star {  module sdb {
35
36
37/** is used for approving the moving and changing of rowset actions.
38 */
39published interface XRowSetApproveListener: com::sun::star::lang::XEventListener
40{
41
42    /** is called before a rowset's cursor is moved.
43        @param event
44            the event which happend
45        @returns <TRUE/> when moving is allowed, otherwise <FALSE/>
46     */
47    boolean approveCursorMove([in]com::sun::star::lang::EventObject event);
48    //-------------------------------------------------------------------------
49
50    /** is called before a row is inserted, updated, or deleted.
51        @param event
52            the event which happend
53        @returns <TRUE/> when changing is allowed, otherwise <FALSE/>
54     */
55    boolean approveRowChange([in]RowChangeEvent event);
56    //-------------------------------------------------------------------------
57
58    /** is called before a rowset is changed, or in other words
59        before a rowset is reexecuted.
60        @param event
61            the event which happend
62        @returns <TRUE/> when changing is allowed, otherwise <FALSE/>
63    */
64    boolean approveRowSetChange([in]com::sun::star::lang::EventObject event);
65};
66
67//=============================================================================
68
69}; }; }; };
70
71/*===========================================================================
72===========================================================================*/
73#endif
74