LibreOffice
LibreOffice 24.2 SDK API Reference
Public Member Functions | List of all members
DatabaseDataProvider Service Reference

import"DatabaseDataProvider.idl";

Inheritance diagram for DatabaseDataProvider:
XDatabaseDataProvider XDataProvider XRangeXMLConversion XInitialization XComponent XPropertySet XParameters XRowSet XInterface XInterface XInterface XInterface XInterface XInterface XResultSet XInterface

Public Member Functions

 createWithConnection ([in] com::sun::star::sdbc::XConnection connection)
 
- Public Member Functions inherited from XDataProvider
boolean createDataSourcePossible ([in] sequence< com::sun::star::beans::PropertyValue > aArguments)
 If TRUE is returned, a call to createDataSource with the same arguments must return a valid XDataSequence object. More...
 
XDataSource createDataSource ([in] sequence< com::sun::star::beans::PropertyValue > aArguments) raises ( com::sun::star::lang::IllegalArgumentException )
 Creates a data source object that matches the given range representation string. More...
 
sequence< com::sun::star::beans::PropertyValuedetectArguments ([in] XDataSource xDataSource)
 Tries to find out with what parameters the passed DataSource most probably was created. More...
 
boolean createDataSequenceByRangeRepresentationPossible ([in] string aRangeRepresentation)
 If TRUE is returned, a call to createDataSequenceByRangeRepresentation with the same argument must return a valid XDataSequence object. More...
 
XDataSequence createDataSequenceByRangeRepresentation ([in] string aRangeRepresentation) raises ( com::sun::star::lang::IllegalArgumentException )
 creates a single data sequence for the given data range. More...
 
XDataSequence createDataSequenceByValueArray ([in] string aRole, [in] string aValueArray, [in] string aRoleQualifier) raises ( com::sun::star::lang::IllegalArgumentException )
 Creates a single data sequence from the string value array representation. More...
 
com::sun::star::sheet::XRangeSelection getRangeSelection ()
 Returns a component that is able to change a given range representation to another one. 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 XRangeXMLConversion
string convertRangeToXML ([in] string aRangeRepresentation) raises ( com::sun::star::lang::IllegalArgumentException )
 converts the range to a valid XML syntax. More...
 
string convertRangeFromXML ([in] string aXMLRange) raises ( com::sun::star::lang::IllegalArgumentException )
 converts an XML-style range into the internal DataProvider's format. More...
 
- Public Member Functions inherited from XInitialization
void initialize ([in] sequence< any > aArguments) raises ( com::sun::star::uno::Exception )
 initializes the object. More...
 
- Public Member Functions inherited from XComponent
void dispose ()
 The owner of an object calls this method to explicitly free all resources kept by this object and thus break cyclic references. More...
 
void addEventListener ([in] XEventListener xListener)
 adds an event listener to the object. More...
 
void removeEventListener ([in] XEventListener aListener)
 removes an event listener from the listener list. 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...
 
- Public Member Functions inherited from XParameters
void setNull ([in]long parameterIndex, [in]long sqlType) raises (SQLException)
 sets the designated parameter to SQL NULL. More...
 
void setObjectNull ([in]long parameterIndex, [in]long sqlType, [in]string typeName) raises (SQLException)
 sets the designated parameter to SQL NULL. More...
 
void setBoolean ([in]long parameterIndex, [in]boolean x) raises (SQLException)
 sets the designated parameter to a boolean value. More...
 
void setByte ([in]long parameterIndex, [in]byte x) raises (SQLException)
 sets the designated parameter to a byte value. More...
 
void setShort ([in]long parameterIndex, [in]short x) raises (SQLException)
 sets the designated parameter to a short value. More...
 
void setInt ([in]long parameterIndex, [in]long x) raises (SQLException)
 sets the designated parameter to a long value. More...
 
void setLong ([in]long parameterIndex, [in]hyper x) raises (SQLException)
 sets the designated parameter to a hyper value. More...
 
void setFloat ([in]long parameterIndex, [in]float x) raises (SQLException)
 sets the designated parameter to a float value. More...
 
void setDouble ([in]long parameterIndex, [in]double x) raises (SQLException)
 sets the designated parameter to a double value. More...
 
void setString ([in]long parameterIndex, [in]string x) raises (SQLException)
 sets the designated parameter to a string value. More...
 
void setBytes ([in]long parameterIndex, [in]sequence< byte > x) raises (SQLException)
 sets the designated parameter to a sequence of bytes. More...
 
void setDate ([in]long parameterIndex, [in]com::sun::star::util::Date x) raises (SQLException)
 sets the designated parameter to a date value. More...
 
void setTime ([in]long parameterIndex, [in]com::sun::star::util::Time x) raises (SQLException)
 sets the designated parameter to a time value. More...
 
void setTimestamp ([in]long parameterIndex, [in]com::sun::star::util::DateTime x) raises (SQLException)
 sets the designated parameter to a datetime value. More...
 
void setBinaryStream ([in]long parameterIndex, [in]com::sun::star::io::XInputStream x, [in]long length) raises (SQLException)
 sets the designated parameter to the given input stream, which will have the specified number of bytes. More...
 
void setCharacterStream ([in]long parameterIndex, [in]com::sun::star::io::XInputStream x, [in]long length) raises (SQLException)
 sets the designated parameter to the given input stream, which will have the specified number of bytes. More...
 
void setObject ([in]long parameterIndex, [in]any x) raises (SQLException)
 sets the value of a parameter using an any. More...
 
void setObjectWithInfo ([in]long parameterIndex, [in]any x, [in]long targetSqlType, [in]long scale) raises (SQLException)
 set a value from the Datatype ANY for a parameter. More...
 
void setRef ([in]long parameterIndex, [in]XRef x) raises (SQLException)
 sets a REF(&lt;structured-type&gt;) parameter. More...
 
void setBlob ([in]long parameterIndex, [in]XBlob x) raises (SQLException)
 sets a BLOB parameter. More...
 
void setClob ([in]long parameterIndex, [in]XClob x) raises (SQLException)
 sets a CLOB parameter. More...
 
void setArray ([in]long parameterIndex, [in]XArray x) raises (SQLException)
 sets an Array parameter. More...
 
void clearParameters () raises (SQLException)
 clears the current parameter values immediately. More...
 
- Public Member Functions inherited from XRowSet
void execute () raises (SQLException)
 populates a row set with data. More...
 
void addRowSetListener ([in]XRowSetListener listener)
 adds the specified listener to receive the events "cursorMoved", "rowChanged", and "rowSetChanged". More...
 
void removeRowSetListener ([in]XRowSetListener listener)
 removes the specified listener. More...
 
- Public Member Functions inherited from XResultSet
boolean next () raises (SQLException)
 moves the cursor down one row from its current position. More...
 
boolean isBeforeFirst () raises (SQLException)
 indicates whether the cursor is before the first row in the result set. More...
 
boolean isAfterLast () raises (SQLException)
 indicates whether the cursor is after the last row in the result set. More...
 
boolean isFirst () raises (SQLException)
 indicates whether the cursor is on the first row of the result set. More...
 
boolean isLast () raises (SQLException)
 indicates whether the cursor is on the last row of the result set. More...
 
void beforeFirst () raises (SQLException)
 moves the cursor to the front of the result set, just before the first row. More...
 
void afterLast () raises (SQLException)
 moves the cursor to the end of the result set, just after the last row. More...
 
boolean first () raises (SQLException)
 moves the cursor to the first row in the result set. More...
 
boolean last () raises (SQLException)
 moves the cursor to the last row in the result set. More...
 
long getRow () raises (SQLException)
 retrieves the current row number. More...
 
boolean absolute ([in] long row) raises (SQLException)
 moves the cursor to the given row number in the result set. More...
 
boolean relative ([in]long rows) raises (SQLException)
 moves the cursor a relative number of rows, either positive or negative. More...
 
boolean previous () raises (SQLException)
 moves the cursor to the previous row in the result set. More...
 
void refreshRow () raises (SQLException)
 refreshes the current row with its most recent value in the database. More...
 
boolean rowUpdated () raises (SQLException)
 indicates whether the current row has been updated. More...
 
boolean rowInserted () raises (SQLException)
 indicates whether the current row has had an insertion. More...
 
boolean rowDeleted () raises (SQLException)
 indicates whether a row has been deleted. More...
 
com::sun::star::uno::XInterface getStatement () raises (SQLException)
 returns the Statement that produced this com::sun::star::sdbc::ResultSet object. More...
 

Additional Inherited Members

- Exported Interfaces inherited from XDatabaseDataProvider
interface XDataProvider
 For accessing data a component provides for being used by charts. More...
 
interface XRangeXMLConversion
 allows you to convert the ranges a data provider deals with internally into valid XML. More...
 
interface com::sun::star::lang::XInitialization
 allows access to the properties of the instance. More...
 
interface com::sun::star::lang::XComponent
 allows life-time control of the database data provider. More...
 
interface com::sun::star::beans::XPropertySet
 allows access to the properties of the instance. More...
 
interface com::sun::star::sdbc::XParameters
 
interface com::sun::star::sdbc::XRowSet
 
- Public Attributes inherited from XDatabaseDataProvider
sequence< string > MasterFields
 is used for subreports and contains the names of columns of the parent report. More...
 
sequence< string > DetailFields
 is used for subreports and contains the names of the columns of the subreport which are related to the master fields of the parent report. More...
 
string Command
 is the command which should be executed, the type of command depends on the CommandType. More...
 
long CommandType
 specifies the type of the command to be executed to retrieve a result set. More...
 
string Filter
 specifies an additional filter to optionally use. More...
 
boolean ApplyFilter
 indicates whether the filter should be applied or not, default is FALSE. More...
 
string HavingClause { set raises(com::sun::star::beans::UnknownPropertyException); }
 additional having clause for the row set More...
 
string GroupBy { set raises(com::sun::star::beans::UnknownPropertyException); }
 additional group by for the row set More...
 
string Order
 is an additional sort order definition for a row set. More...
 
boolean EscapeProcessing
 specifies if the Command should be analyzed on the client side before sending it to the database server. More...
 
long RowLimit
 specifies the maximal count of rows which should be fetched. More...
 
com::sun::star::sdbc::XConnection ActiveConnection { set raises(com::sun::star::lang::IllegalArgumentException); }
 specifies the active connection which is used to create the resulting report. More...
 
string DataSourceName
 is the name of the data source to use, this could be a named data source or the URL of a data access component. More...
 

Member Function Documentation

◆ createWithConnection()

createWithConnection ( [in] com::sun::star::sdbc::XConnection  connection)

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