LibreOffice
LibreOffice 6.2 SDK API Reference
Included Services | Exported Interfaces | Public Attributes | List of all members
QueryDescriptor Service Referencepublished

is a stored definition of a SQL "Select statement". More...

import"QueryDescriptor.idl";

Inheritance diagram for QueryDescriptor:
Descriptor XDataDescriptorFactory DataSettings XColumnsSupplier XPropertySet XInterface XInterface XInterface

Included Services

service com::sun::star::sdbcx::Descriptor
 
service com::sun::star::sdb::DataSettings
 is used for customization of data appearance. More...
 

Exported Interfaces

interface com::sun::star::sdbcx::XDataDescriptorFactory
 is provided for creation of a new query descriptor based on the current information. More...
 
interface com::sun::star::sdbcx::XColumnsSupplier
 access to the columns of the results sets query. More...
 
- Exported Interfaces inherited from Descriptor
interface com::sun::star::beans::XPropertySet
 

Public Attributes

string Command
 is the command of the query, this is typically a select statement. More...
 
boolean EscapeProcessing
 should we use escape processing for the query. More...
 
string UpdateTableName
 is the name of the table which should be updated. More...
 
string UpdateCatalogName
 is the name of the update table catalog. More...
 
string UpdateSchemaName
 is the name of the update table schema. More...
 
- Public Attributes inherited from Descriptor
string Name
 is the name for the object to create. More...
 
- Public Attributes inherited from DataSettings
string Filter
 additional filter for the data object. More...
 
boolean ApplyFilter
 indicates whether the filter should be applied or not, default is FALSE. More...
 
string Order
 is an additional sort order definition. More...
 
com::sun::star::awt::FontDescriptor FontDescriptor
 specifies the font attributes for data displaying. More...
 
long RowHeight
 specifies the height of a data row. More...
 
com::sun::star::util::Color TextColor
 specifies the text color (RGB) for displaying text. More...
 
string HavingClause
 additional having clause for the data object. More...
 
string GroupBy
 additional group by for the data object. More...
 

Additional Inherited Members

- 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...
 
- 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 XDataDescriptorFactory
com::sun::star::beans::XPropertySet createDataDescriptor ()
 returns a descriptor of a definition object. More...
 
- Public Member Functions inherited from XColumnsSupplier
com::sun::star::container::XNameAccess getColumns ()
 returns the container of columns. More...
 

Detailed Description

is a stored definition of a SQL "Select statement".

It can be used, if there is a need to execute SQL statement more than once or if you want to format the query result fields different from the underlying table definitions.

Exported Interfaces

is used for customization of data appearance.

Exported Interfaces

access to the columns of the results sets query.

is provided for creation of a new query descriptor based on the current information.

Member Data Documentation

string Command
property

is the command of the query, this is typically a select statement.

boolean EscapeProcessing
property

should we use escape processing for the query.

string UpdateCatalogName
property

is the name of the update table catalog.

string UpdateSchemaName
property

is the name of the update table schema.

string UpdateTableName
property

is the name of the table which should be updated.

This is usually used for queries which relate on more than one table.


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