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#ifndef __com_sun_star_ucb_ListAction_idl__ 28#define __com_sun_star_ucb_ListAction_idl__ 29 30 31//============================================================================= 32 33module com { module sun { module star { module ucb { 34 35//============================================================================= 36/** This struct contains information needed in the notifications of a 37 <type>XDynamicResultSet</type>. 38 39 @see ListEvent 40*/ 41 42published struct ListAction 43{ 44 //------------------------------------------------------------------------- 45 /** The position where something has happened (index begins with 46 <code>1</code> as usual with JDBC ). 47 48 <p>Its value does not necessary indicate the new position in the new 49 <type scope="com::sun::star::sdbc">XResultSet</type>, but a position 50 while doing the changes step by step beginning with the old 51 <type scope="com::sun::star::sdbc">XResultSet</type>. 52 */ 53 long Position; 54 55 //------------------------------------------------------------------------- 56 /** The count of involved rows. 57 */ 58 long Count; 59 60 61 //------------------------------------------------------------------------- 62 /** specifies the kind of modification happened to all assigned rows. 63 64 <p>The value of the other members of this struct depend on the value 65 of this member: 66 67 <table border=1> 68 <tr align=left> <th>ListActionType</th> 69 <th>Position</th> 70 <th>Count</th> 71 <th>ActionInfo</th></tr> 72 73 <tr align=left> <td>WELCOME</td> 74 <td>n/a</td> 75 <td>n/a</td> 76 <td><type>WelcomeDynamicResultSetStruct</type> required</td></tr> 77 78 <tr align=left> <td>CLEARED</td> 79 <td>n/a</td> 80 <td>n/a</td> 81 <td>n/a</td></tr> 82 83 <tr align=left> <td>INSERTED</td> 84 <td>required 1-x</td> 85 <td>required 1-x</td> 86 <td>allowed but not required... @todo </td></tr> 87 88 <tr align=left> <td>REMOVED</td> 89 <td>required 1-x</td> 90 <td>required 1-x</td> 91 <td>n/a</td></tr> 92 93 <tr align=left> <td>MOVED</td> 94 <td>required 1-x</td> 95 <td>required 1-x</td> 96 <td>type long required</td></tr> 97 98 <tr align=left> <td>PROPERTIES_CHANGED</td> 99 <td>required 1-x</td> 100 <td>required 1-x</td> 101 <td>allowed but not required... @todo</td></tr> 102 </table> 103 104 <p>The value for this member can be one of the 105 <type>ListActionType</type> constants group. 106 */ 107 long ListActionType; 108 109 //------------------------------------------------------------------------- 110 /** dependend on the content of <member>ListAction::ListActionType</member> 111 the <member>ListAction::ActionInfo</member> could contain additional 112 information about the changes happened (see table above). 113 */ 114 115 any ActionInfo; 116}; 117 118//============================================================================= 119 120}; }; }; }; 121 122#endif 123