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

describes the common properties of a database column. More...

import"Column.idl";

Inheritance diagram for Column:
XDataDescriptorFactory XPropertySet XInterface XInterface Column OrderColumn ResultColumn IndexColumn KeyColumn ReferenceColumn DataColumn

Exported Interfaces

interface XDataDescriptorFactory
 optional, could be used to copy a database column. More...
 
interface com::sun::star::beans::XPropertySet
 

Public Attributes

string Name
 is the name of the column. More...
 
long Type
 is the com::sun::star::sdbc::DataType of the column. More...
 
string TypeName
 is the type name used by the database. More...
 
long Precision
 gets a column's number of decimal digits. More...
 
long Scale
 gets a column's number of digits to right of the decimal point. More...
 
long IsNullable
 indicates the nullability of values in the designated column. More...
 
boolean IsAutoIncrement
 indicates whether the column is automatically numbered, thus read-only. More...
 
boolean IsCurrency
 indicates whether the column is a cash value. More...
 
boolean IsRowVersion
 indicates that the column contains some kind of time or date stamp used to track updates. More...
 
string Description
 keeps a description of the object. More...
 
string DefaultValue
 keeps a default value for a column, is provided as string. 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...
 
- 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 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

describes the common properties of a database column.

Developers Guide
Database - Column Service

Exported Interfaces

interface XDataDescriptorFactory
optional

optional, could be used to copy a database column.

Member Data Documentation

string DefaultValue
optionalpropertyreadonly

keeps a default value for a column, is provided as string.

string Description
optionalpropertyreadonly

keeps a description of the object.

boolean IsAutoIncrement
propertyreadonly

indicates whether the column is automatically numbered, thus read-only.

See also
com::sun::star::sdbc::ColumnValue
boolean IsCurrency
propertyreadonly

indicates whether the column is a cash value.

long IsNullable
propertyreadonly

indicates the nullability of values in the designated column.

See also
com::sun::star::sdbc::ColumnValue
boolean IsRowVersion
optionalpropertyreadonly

indicates that the column contains some kind of time or date stamp used to track updates.

string Name
propertyreadonly

is the name of the column.

long Precision
propertyreadonly

gets a column's number of decimal digits.

long Scale
propertyreadonly

gets a column's number of digits to right of the decimal point.

long Type
propertyreadonly

is the com::sun::star::sdbc::DataType of the column.

string TypeName
propertyreadonly

is the type name used by the database.

If the column type is a user-defined type, then a fully-qualified type name is returned. Note: May be empty.


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