xref: /AOO41X/main/offapi/com/sun/star/sdbc/BestRowScope.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_sdbc_BestRowScope_idl__
24#define __com_sun_star_sdbc_BestRowScope_idl__
25
26 module com {  module sun {  module star {  module sdbc {
27
28
29/** determines how long a row identifier is valid.
30 */
31published constants BestRowScope
32{
33
34    /** indicates that the scope of the best row identifier is
35             very temporary, lasting only while the row is being used.
36             A possible value for the column
37             <code>SCOPE</code>
38             in the
39             <type scope="com::sun::star::sdbc">XResultSet</type>
40             object
41             returned by the method
42             <member>XDatabaseMetaData::getBestRowIdentifier()</member>
43             .
44     */
45    const long TEMPORARY   = 0;
46    //-------------------------------------------------------------------------
47
48    /** indicates that the scope of the best row identifier is
49             the remainder of the current transaction.
50             A possible value for the column
51             <code>SCOPE</code>
52             in the
53             <type scope="com::sun::star::sdbc">XResultSet</type>
54             object
55             returned by the method
56             <member>XDatabaseMetaData::getBestRowIdentifier()</member>
57             .
58     */
59    const long TRANSACTION = 1;
60    //-------------------------------------------------------------------------
61
62    /** indicates that the scope of the best row identifier is
63             the remainder of the current session.
64             A possible value for the column
65             <code>SCOPE</code>
66             in the
67             <type scope="com::sun::star::sdbc">XResultSet</type>
68             object
69             returned by the method
70             <member>XDatabaseMetaData::getBestRowIdentifier()</member>
71             .
72     */
73    const long SESSION     = 2;
74};
75
76//=============================================================================
77
78}; }; }; };
79
80/*===========================================================================
81===========================================================================*/
82#endif
83