LibreOffice LibreOffice 25.8 SDK API Reference

Included Services | Exported Interfaces | Public Attributes | List of all members
DataColumn Service Referencepublished

defines a column used for a result set which contains the data definition and the data of the column of the current row of a result set. More...

`import"DataColumn.idl";`

Inheritance diagram for DataColumn:

## Included Services
service | com::sun::star::sdb::ResultColumn
Included Services inherited from ResultColumn
service | com::sun::star::sdbcx::Column
service | com::sun::star::sdb::ColumnSettings
| [optional], access to layout settings for a column. More...

## Exported Interfaces
interface | XColumn
| is used to retrieve the columns value. More...
interface | XColumnUpdate
| is used to update the columns value. More...
Exported Interfaces inherited from Column
interface | XDataDescriptorFactory
| optional, could be used to copy a database column. More...
interface | com::sun::star::beans::XPropertySet
Exported Interfaces inherited from ColumnSettings
interface | com::sun::star::beans::XPropertySet

## Public Attributes
any | Value
| contains the column's value. More...
any | OriginalValue
| contains the original value of the column. More...
Public Attributes inherited from ResultColumn
boolean | IsSearchable
| indicates whether the column can be used in a Where clause. More...
boolean | IsSigned
| indicates whether values in the column are signed numbers. More...
boolean | IsCaseSensitive
| indicates that a column is case sensitive. More...
long | DisplaySize
| indicates the column's normal max width in chars. More...
string | Label
| gets the suggested column title for use in printouts and displays. More...
boolean | IsReadOnly
| indicates whether a column is definitely, not writable. More...
boolean | IsWritable
| indicates whether it is possible for a write on the column to succeed. More...
boolean | IsDefinitelyWritable
| indicates whether a write on the column will definitely succeed. More...
string | ServiceName
| returns the fully-qualified name of the service whose instances are manufactured if the method com::sun::star::sdbc::XRow::getObject)= is called to retrieve a value from the column. More...
string | TableName
| gets a column's table name. More...
string | SchemaName
| gets a column's schema name. More...
string | CatalogName
| gets a column's table's catalog name. More...
Public Attributes inherited from Column
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...
Public Attributes inherited from ColumnSettings
long | FormatKey
| contains the index of the number format that is used for the column. More...
long | Align
| specifies the alignment of columns text. More...
long | Width
| specifies the width of the column displayed in a grid, the unit is 10THMM. More...
long | Position
| Position of the column within a grid. More...
boolean | Hidden
| determines whether the column should be displayed or not. More...
com::sun::star::beans::XPropertySet | ControlModel
| indicates a control model which defines the settings for layouting. More...
string | HelpText
| describes an optional help text which can be used by UI components when representing this column. More...
string | ControlDefault
| describes the default value which should be displayed by a control when moving to a new row. 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 XColumn
boolean | wasNull () raises (com::sun::star::sdbc::SQLException)
| reports whether the last column read had a value of SQL NULL. More...
string | getString () raises (com::sun::star::sdbc::SQLException)
| gets the value of a column in the current row as a String. More...
boolean | getBoolean () raises (com::sun::star::sdbc::SQLException)
| gets the value of a column in the current row as boolean. More...
byte | getByte () raises (com::sun::star::sdbc::SQLException)
| gets the value of a column in the current row as a byte. More...
short | getShort () raises (com::sun::star::sdbc::SQLException)
| gets the value of a column in the current row as a short. More...
long | getInt () raises (com::sun::star::sdbc::SQLException)
| gets the value of a column in the current row as a long. More...
hyper | getLong () raises (com::sun::star::sdbc::SQLException)
| gets the value of a column in the current row as a hyper. More...
float | getFloat () raises (com::sun::star::sdbc::SQLException)
| gets the value of a column in the current row as a float. More...
double | getDouble () raises (com::sun::star::sdbc::SQLException)
| gets the value of a column in the current row as a double. More...
sequence< byte > | getBytes () raises (com::sun::star::sdbc::SQLException)
| gets the value of a column in the current row as a byte array. More...
com::sun::star::util::Date | getDate () raises (com::sun::star::sdbc::SQLException)
| gets the value of a column in the current row as a date object. More...
com::sun::star::util::Time | getTime () raises (com::sun::star::sdbc::SQLException)
| gets the value of a column in the current row as a time object. More...
com::sun::star::util::DateTime | getTimestamp () raises (com::sun::star::sdbc::SQLException)
| gets the value of a column in the current row as a datetime object. More...
com::sun::star::io::XInputStream | getBinaryStream () raises (com::sun::star::sdbc::SQLException)
| gets the value of a column in the current row as a stream of uninterpreted bytes. More...
com::sun::star::io::XInputStream | getCharacterStream () raises (com::sun::star::sdbc::SQLException)
| gets the value of a column in the current row as a stream of uninterpreted bytes. More...
any | getObject ([in]com::sun::star::container::XNameAccess typeMap) raises (com::sun::star::sdbc::SQLException)
com::sun::star::sdbc::XRef | getRef () raises (com::sun::star::sdbc::SQLException)
| gets a REF(<structured-type&gt) column value from the current row. More...
com::sun::star::sdbc::XBlob | getBlob () raises (com::sun::star::sdbc::SQLException)
| gets a BLOB (Binary Large OBject) value in the current row. More...
com::sun::star::sdbc::XClob | getClob () raises (com::sun::star::sdbc::SQLException)
| gets a CLOB value in the current row of this `ResultSet` object. More...
com::sun::star::sdbc::XArray | getArray () raises (com::sun::star::sdbc::SQLException)
| gets a SQL ARRAY value from the current row. More...
Public Member Functions inherited from XColumnUpdate
void | updateNull () raises (com::sun::star::sdbc::SQLException)
| gives a nullable column a null value. More...
void | updateBoolean ([in]boolean x) raises (com::sun::star::sdbc::SQLException)
| updates a column with a boolean value. More...
void | updateByte ([in]byte x) raises (com::sun::star::sdbc::SQLException)
| updates a column with a byte value. More...
void | updateShort ([in]short x) raises (com::sun::star::sdbc::SQLException)
| updates a column with a short value. More...
void | updateInt ([in]long x) raises (com::sun::star::sdbc::SQLException)
| updates a column with a long value. More...
void | updateLong ([in]hyper x) raises (com::sun::star::sdbc::SQLException)
| updates a column with a hyper value. More...
void | updateFloat ([in]float x) raises (com::sun::star::sdbc::SQLException)
| updates a column with a float value. More...
void | updateDouble ([in]double x) raises (com::sun::star::sdbc::SQLException)
| updates a column with a double value. More...
void | updateString ([in]string x) raises (com::sun::star::sdbc::SQLException)
| updates a column with a string value. More...
void | updateBytes ([in]sequence< byte > x) raises (com::sun::star::sdbc::SQLException)
| updates a column with a byte array value. More...
void | updateDate ([in]com::sun::star::util::Date x) raises (com::sun::star::sdbc::SQLException)
| updates a column with a Date value. More...
void | updateTime ([in]com::sun::star::util::Time x) raises (com::sun::star::sdbc::SQLException)
| updates a column with a Time value. More...
void | updateTimestamp ([in]com::sun::star::util::DateTime x) raises (com::sun::star::sdbc::SQLException)
| updates a column with a Timestamp value. More...
void | updateBinaryStream ([in]com::sun::star::io::XInputStream x, [in]long length) raises (com::sun::star::sdbc::SQLException)
| updates a column with a stream value. More...
void | updateCharacterStream ([in]com::sun::star::io::XInputStream x, [in]long length) raises (com::sun::star::sdbc::SQLException)
| updates a column with a stream value. More...
void | updateObject ([in]any x) raises (com::sun::star::sdbc::SQLException)
| updates a column with an Object value. More...
void | updateNumericObject ([in]any x, [in]long scale) raises (com::sun::star::sdbc::SQLException)
| updates a column with an Object value. 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

defines a column used for a result set which contains the data definition and the data of the column of the current row of a result set.

## Exported Interfaces

## ◆ com::sun::star::sdb::ResultColumn

service com::sun::star::sdb::ResultColumn

## Exported Interfaces

## ◆ XColumn

interface XColumn

is used to retrieve the columns value.

## ◆ XColumnUpdate

interface XColumnUpdate

is used to update the columns value.

## Member Data Documentation

## ◆ OriginalValue

any OriginalValue
| optional property readonly

contains the original value of the column.

## ◆ Value

any Value
| optional property

contains the column's value.

This could be a constraint property, to veto modifications, if a new value does not fit into rules defined for the column.

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

- com/sun/star/sdb/DataColumn.idl