LibreOffice
LibreOffice 7.4 SDK API Reference
Exported Interfaces | Public Attributes | List of all members
Index Service Referencepublished

is used to specify the index for a database table. More...

import"Index.idl";

Inheritance diagram for Index:
XDataDescriptorFactory XColumnsSupplier XPropertySet XInterface XInterface XInterface

Exported Interfaces

interface XDataDescriptorFactory
 optional, could be used to copy an index. More...
 
interface XColumnsSupplier
 access to the contained index columns. More...
 
interface com::sun::star::beans::XPropertySet
 

Public Attributes

string Name
 is the name of the index. More...
 
string Catalog
 is the name of the index catalog, may be empty. More...
 
boolean IsUnique
 indicates that the index allow only unique values. More...
 
boolean IsPrimaryKeyIndex
 indicates that the index is used for the primary key. More...
 
boolean IsClustered
 indicates that the index is clustered. More...
 

Additional Inherited Members

- Public Member Functions inherited from XColumnsSupplier
com::sun::star::container::XNameAccess getColumns ()
 returns the container of columns. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 
- Public Member Functions inherited from XPropertySet
com::sun::star::beans::XPropertySetInfo getPropertySetInfo ()
 
void setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
 sets the value of the property with the specified name. More...
 
any getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 
void addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 adds an XPropertyChangeListener to the specified property. More...
 
void removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 removes an XPropertyChangeListener from the listener list. More...
 
void addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 adds an XVetoableChangeListener to the specified property with the name PropertyName. More...
 
void removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 removes an XVetoableChangeListener from the listener list. More...
 
- Protected Member Functions inherited from XDataDescriptorFactory
com::sun::star::beans::XPropertySet createDataDescriptor ()
 returns a descriptor of a definition object. More...
 
- Protected Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 
- Protected Member Functions inherited from XColumnsSupplier
com::sun::star::container::XNameAccess getColumns ()
 returns the container of columns. More...
 
- Protected Member Functions inherited from XPropertySet
com::sun::star::beans::XPropertySetInfo getPropertySetInfo ()
 
void setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
 sets the value of the property with the specified name. More...
 
any getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 
void addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 adds an XPropertyChangeListener to the specified property. More...
 
void removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 removes an XPropertyChangeListener from the listener list. More...
 
void addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 adds an XVetoableChangeListener to the specified property with the name PropertyName. More...
 
void removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 removes an XVetoableChangeListener from the listener list. More...
 

Detailed Description

is used to specify the index for a database table.

It refers to one or more columns of a table.

Note: All properties and columns of an index could by modified before they are appended to a table. In that case the service is a data descriptor.

Exported Interfaces

◆ com::sun::star::beans::XPropertySet

◆ XColumnsSupplier

interface XColumnsSupplier

access to the contained index columns.

◆ XDataDescriptorFactory

interface XDataDescriptorFactory
optional

optional, could be used to copy an index.

Member Data Documentation

◆ Catalog

string Catalog
propertyreadonly

is the name of the index catalog, may be empty.

◆ IsClustered

boolean IsClustered
propertyreadonly

indicates that the index is clustered.

◆ IsPrimaryKeyIndex

boolean IsPrimaryKeyIndex
propertyreadonly

indicates that the index is used for the primary key.

◆ IsUnique

boolean IsUnique
propertyreadonly

indicates that the index allow only unique values.

◆ Name

string Name
propertyreadonly

is the name of the index.


The documentation for this service was generated from the following file: