1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_sdbcx_Index_idl__ 24cdf0e10cSrcweir#define __com_sun_star_sdbcx_Index_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_beans_XPropertySet_idl__ 27cdf0e10cSrcweir#include <com/sun/star/beans/XPropertySet.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir module com { module sun { module star { module sdbcx { 31cdf0e10cSrcweir 32cdf0e10cSrcweir published interface XColumnsSupplier; 33cdf0e10cSrcweir published interface XDataDescriptorFactory; 34cdf0e10cSrcweir 35cdf0e10cSrcweir 36cdf0e10cSrcweir/** is used to specify the index for a database table. It refers to one or 37cdf0e10cSrcweir more columns of a table. 38cdf0e10cSrcweir <p> 39cdf0e10cSrcweir <b> 40cdf0e10cSrcweir Note: 41cdf0e10cSrcweir </b> 42cdf0e10cSrcweir All properties and columns of an index could by modified before they are appended 43cdf0e10cSrcweir to a table. In that case the service is a data descriptor. 44cdf0e10cSrcweir </p> 45cdf0e10cSrcweir */ 46cdf0e10cSrcweirpublished service Index 47cdf0e10cSrcweir{ 48cdf0e10cSrcweir 49cdf0e10cSrcweir /** optional, could be used to copy an index. 50cdf0e10cSrcweir */ 51cdf0e10cSrcweir [optional] interface XDataDescriptorFactory; 52cdf0e10cSrcweir 53cdf0e10cSrcweir 54cdf0e10cSrcweir /** access to the contained index columns. 55cdf0e10cSrcweir */ 56cdf0e10cSrcweir interface XColumnsSupplier; 57cdf0e10cSrcweir 58cdf0e10cSrcweir // gives access to the properties. 59cdf0e10cSrcweir interface com::sun::star::beans::XPropertySet; 60cdf0e10cSrcweir 61cdf0e10cSrcweir 62cdf0e10cSrcweir /** is the name of the index. 63cdf0e10cSrcweir */ 64cdf0e10cSrcweir [readonly, property] string Name; 65cdf0e10cSrcweir 66cdf0e10cSrcweir 67cdf0e10cSrcweir /** is the name of the index catalog, may be empty. 68cdf0e10cSrcweir */ 69cdf0e10cSrcweir [readonly, property] string Catalog; 70cdf0e10cSrcweir 71cdf0e10cSrcweir 72cdf0e10cSrcweir /** indicates that the index allow only unique values. 73cdf0e10cSrcweir */ 74cdf0e10cSrcweir [readonly, property] boolean IsUnique; 75cdf0e10cSrcweir 76cdf0e10cSrcweir 77cdf0e10cSrcweir /** indicates that the index is used for the primary key. 78cdf0e10cSrcweir */ 79cdf0e10cSrcweir [readonly, property] boolean IsPrimaryKeyIndex; 80cdf0e10cSrcweir 81cdf0e10cSrcweir 82cdf0e10cSrcweir /** indicates that the index is clustered. 83cdf0e10cSrcweir */ 84cdf0e10cSrcweir [readonly, property] boolean IsClustered; 85cdf0e10cSrcweir}; 86cdf0e10cSrcweir 87cdf0e10cSrcweir//============================================================================= 88cdf0e10cSrcweir 89cdf0e10cSrcweir}; }; }; }; 90cdf0e10cSrcweir 91cdf0e10cSrcweir/*=========================================================================== 92cdf0e10cSrcweir===========================================================================*/ 93cdf0e10cSrcweir#endif 94