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