<html> <head> <title>Service RowSet</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="RowSet-xref.html" class="navimain">Use</a></td> <td class="navimain"><a href="#devmanual" class="navimain">Devguide</a></td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#IncludedServices" class="navisub">Included Services</a></td> <td class="navisub"><a href="#ExportedInterfaces" class="navisub">Exported Interfaces</a></td> <td class="navisub"><a href="#PropertiesSummary" class="navisub">Properties' Summary</a></td> <td class="navisub"><a href="#PropertiesDetails" class="navisub">Properties' Details</a></td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">sdb</a> :: </p> </td> </tr> <tr> <td class="title">service RowSet</td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>is a client side RowSet, which use retrieves is data based on a database table, a query or a SQL command or by a rowset reader, who mustn't support SQL. The connection of the rowset is typically a named DataSource or a DataAccess component or a previous instanciated connection. </dd> <dd><p> Depending on the ::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/ResultSetConcurrency.html">ResultSetConcurrency</a> , the RowSet caches all data or uses an optimized way for retrieving the data, such as, refetching rows by their keys or if provided, by their bookmarks. </p> <p> In addition, it provides events for RowSet navigation and RowSet modifications to approve the actions and to react on them. </dd> <dt><b>See also</b></dt> <dd><a href="RowChangeAction.html">RowChangeAction</a>, <a href="ResultSet.html">ResultSet</a></dd> <dt><b>See also</b></dt> <dd><a href="RowChangeEvent.html">RowChangeEvent</a><br> </p> <h3>Notifications</h3> <p>A row set is able to be operated in various ways, and additionally it notifies various changes in it's state. Clients of this service can rely on a fixed order of notifications, depending on how they operate on the component.</br> The following describes the general order of all possible notifications which you can encounter when working with a row set: <table> <tr><td valign="top"><em>approving</em></td> <td valign="top">Before anything really happens, any veto listeners are called to approve the operation which is just being done. This may be either a <a href="XRowSetApproveListener.html">XRowSetApproveListener</a>::<a href="XRowSetApproveListener.html#approveCursorMove">approveCursorMove</a> or <a href="XRowSetApproveListener.html">XRowSetApproveListener</a>::<a href="XRowSetApproveListener.html#approveRowChange">approveRowChange</a> call. </dd> <dt><b>See also</b></dt> <dd><a href="XRowSetApproveListener.html">XRowSetApproveListener</a><br> </td> </tr> <tr><td valign="top"><em>column values</em></td> <td valign="top">If the opration includes changes in the values of the columns of the row set, then these are notified before anything else (except requests for approval). </dd> <dt><b>See also</b></dt> <dd>::com::sun::star::<a href="../sdbcx/module-ix.html">sdbcx</a>::<a href="../sdbcx/XColumnsSupplier.html">XColumnsSupplier</a><br> </td> </tr> <tr><td valign="top"><em>operation done</em></td> <td valign="top">When the operation is done, you get a notification about this. It may be a ::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/XRowSetListener.html">XRowSetListener</a>::<a href="../sdbc/XRowSetListener.html#cursorMoved">cursorMoved</a> or a ::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/XRowSetListener.html">XRowSetListener</a>::<a href="../sdbc/XRowSetListener.html#rowChanged">rowChanged</a> call. </td> </tr> <tr><td valign="top"><em>row state</em></td> <td valign="top">If the operation leads to a change in the state of the <a href="RowSet.html#IsModified">IsModified</a> and/or <a href="RowSet.html#IsNew">IsNew</a> property, this is notified next (in this order). </td> </tr> <tr><td valign="top"><em>row count</em></td> <td valign="top">If the operation leads to new knowledge about the number of rows in the result set, the respective changes in the <a href="RowSet.html#RowCount">RowCount</a> and <a href="RowSet.html#IsRowCountFinal">IsRowCountFinal</a> are notified last (in this order). </td> </tr> </table> </p> <br/> <p>The following matrix shows the notifications which apply to the different operations: <table border="1" frame="all"> <tr><td/><td><strong>approveCursorMove</strong></td><td><strong>approveRowChange</strong></td> <td><strong>column values</strong></td> <td><strong>cursorMoved</strong></td><td><strong>rowChanged</strong></td> <td><strong>IsModified</strong></td><td><strong>IsNew</strong></td> <td><strong>RowCount</strong></td><td><strong>IsRowCountFinal</strong></td> </tr> <tr><td>::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/XResultSet.html">XResultSet</a></td><td/><td/><td/><td/><td/><td/><td/><td/></tr> <tr><td align="right"><em>next</em></td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td> <tr><td align="right"><em>beforeFirst</em></td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td/></tr> <tr><td align="right"><em>afterLast</em></td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td></tr> <tr><td align="right"><em>first</em></td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td></tr> <tr><td align="right"><em>last</em></td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td></tr> <tr><td align="right"><em>absolute</em></td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td></tr> <tr><td align="right"><em>relative</em></td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td></tr> <tr><td align="right"><em>previous</em></td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td></tr> <tr><td align="right"><em>refreshRow</em></td><td/><td/><td align="center">X</td><td/><td/><td align="center">X</td><td align="center">X</td><td/><td/></tr> <tr><td align="right"><em>cancelRowUpdates</em></td><td/><td/><td align="center">X</td><td/><td/><td align="center">X</td><td/><td/><td/></tr> <tr><td>::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/XResultSetUpdate.html">XResultSetUpdate</a></td><td/><td/><td/><td/><td/><td/><td/><td/></tr> <tr><td align="right"><em>insertRow</em></td><td/><td align="center">X</td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td></tr> <tr><td align="right"><em>updateRow</em></td><td/><td align="center">X</td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td/><td/></tr> <tr><td align="right"><em>deleteRow</em></td><td/><td align="center">X</td><td/><td/><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td></tr> <tr><td align="right"><em>moveToInsertRow</em></td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td/><td align="center">X</td><td align="center">X</td></tr> <tr><td align="right"><em>moveToCurrentRow</em></td><td align="center">X</td><td/><td/><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td/></tr> <tr><td>::com::sun::star::<a href="../sdbcx/module-ix.html">sdbcx</a>::<a href="../sdbcx/XDeleteRows.html">XDeleteRows</a></td><td/><td/><td/><td/><td/><td/><td/><td/></tr> <tr><td align="right"><em>deleteRows</em></td><td/><td align="center">X</td><td/><td/><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td></tr> <tr><td>::com::sun::star::<a href="../sdbcx/module-ix.html">sdbcx</a>::<a href="../sdbcx/XRowLocate.html">XRowLocate</a></td><td/><td/><td/><td/><td/><td/><td/><td/></tr> <tr><td align="right"><em>moveToBookmark</em></td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td/></tr> <tr><td align="right"><em>moveRelativeToBookmark</em></td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td/><td align="center">X</td><td align="center">X</td><td align="center">X</td><td align="center">X</td></tr> </tr> </table> </p> <h3>Deletions</h3> <p>Via ::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/XResultSetUpdate.html">XResultSetUpdate</a>::<a href="../sdbc/XResultSetUpdate.html#deleteRow">deleteRow</a>, you can delete the current row of a <a href="RowSet.html">RowSet</a>. This deleted row then doesn't vanish immediately, but is still present, and subsequent calls to ::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/XResultSet.html">XResultSet</a>::<a href="../sdbc/XResultSet.html#rowDeleted">rowDeleted</a> will return <b>true</b>. The deleted row "vanishes" from the <a href="RowSet.html">RowSet</a> as soon as the cursor is moved away from it.<br/> As a consequence, the behaviour of several other methods is affected:<br/> <dl> <dt>::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/XResultSet.html">XResultSet</a>::<a href="../sdbc/XResultSet.html#getRow">getRow</a></dt> <dd>returns the position of the cursor, which has not been changed by the deletion.</dd> <dt>::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/XResultSet.html">XResultSet</a>: <code>next</code>, <code>first</code>, <code>last</code>, <code>absolute</code>, <code>relative</code>, <code>previous</code>, <code>beforeFirst</code>, <code>afterLast</code></dt> <dd>will let the deleted row vanish from the result set. As a consequence, the <a href="RowSet.html#RowCount">RowCount</a> will decrease when you do such a move operation after deleting a row.<br/> A special case to note is the <code>next<code> call: When you delete row, say, <code>15</code>, followed by <code>next</code>, then your <a href="RowSet.html">RowSet</a> afterwards still is on row 15, since the deleted row vanished with the move operation.</dd> <dt>::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/XResultSet.html">XResultSet</a>::<a href="../sdbc/XResultSet.html#refreshRow">refreshRow</a></dt> <dd>will throw an exception when the cursor is on a deleted row.</dd> <dt>::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/XRow.html">XRow</a>: <code>getFoo</code></dt> <dd>will return an empty value when the cursor is on a deleted row.</dd> <dt>::com::sun::star::<a href="../sdbcx/module-ix.html">sdbcx</a>::<a href="../sdbcx/XRowLocate.html">XRowLocate</a>::<a href="../sdbcx/XRowLocate.html#getBookmark">getBookmark</a></dt> <dd>will throw an exception when the cursor is on a deleted row.</dd> <dt>::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/XRowUpdate.html">XRowUpdate</a>: <code>updateFoo</code></dt> <dd>will throw an exception when the cursor is on a deleted row.</dd> <dt>::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/XResultSetUpdate.html">XResultSetUpdate</a>::<a href="../sdbc/XResultSetUpdate.html#deleteRow">deleteRow</a></dt> <dd>will throw an exception when the cursor is on a deleted row.</dd> <dt>::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/XResultSetUpdate.html">XResultSetUpdate</a>::<a href="../sdbc/XResultSetUpdate.html#moveToInsertRow">moveToInsertRow</a></dt> <dd>will let the deleted row vanish from the result set. As a consequence, the <a href="RowSet.html#RowCount">RowCount</a> will decrease. Also, subsequent calls to ::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/XResultSetUpdate.html">XResultSetUpdate</a>::<a href="../sdbc/XResultSetUpdate.html#moveToCurrentRow">moveToCurrentRow</a> will not be able to move back to the deleted row (since it vanished), but only to the row after the deleted row.</dd> </dl> </p> </dd> </dl> <a name="devmanual"> </a><dl> <dt><b>Developers Guide</b></dt> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Forms/Forms_as_Row_Sets">Forms - Forms as Row Sets</a></dd> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Database/The_RowSet_Service">Database - The RowSet Service</a></dd> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/Database/Example:_Querying_the_Bibliography_Database">Database - Example: Querying the Bibliography Database</a></dd> </dl> </td> </tr> </table> <hr> <a name="IncludedServices"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Included Services</td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/RowSet.html">RowSet</a></td> <td class="imsum_right"><dl> <dt>(referenced entity's summary:)</dt> <dd>is a client side ResultSet, which combines the characteristics of a ::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/Statement.html">Statement</a> and a ::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/ResultSet.html">ResultSet</a>. </dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="ResultSet.html">ResultSet</a></td> <td class="imsum_right"><dl> <dt>(referenced entity's summary:)</dt> <dd>extends the ::com::sun::star::<a href="../sdbcx/module-ix.html">sdbcx</a>::<a href="../sdbcx/ResultSet.html">ResultSet</a> by a more sophisticated access to the result sets data. </dd> </dl> </td> </tr> </table> <a name="ExportedInterfaces"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Exported Interfaces</td> </tr> <tr> <td class="imsum_left"><a href="XCompletedExecution.html">XCompletedExecution</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>can be used to allow an interaction handler to supply missing data during a execute process. </dd> <dd><p>If you want a row set to be based on a parametrized query, you will usually use the ::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/XParameters.html">XParameters</a> interface.<br/> However, you can also choose to let an interaction handler supply such data. For this, you may for instance instantiate an <a href="InteractionHandler.html">InteractionHandler</a>, which asks the user for the data, or you may write your own one, which supplies the data from somewhere else.</p> </dd> <dt><b/></dt> <dd/></dl> </td> </tr> <tr> <td class="imsum_left"><a href="XRowSetApproveBroadcaster.html">XRowSetApproveBroadcaster</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>approving of actions performed on the rowset. </dd> <dd><p>The support of this interface implies a sematical extension to the ::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/XResultSetUpdate.html">XResultSetUpdate</a> interface which is supported via the ::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/ResultSet.html">ResultSet</a>.</p> </dd> <dt><b/></dt> <dd/></dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/XResultSetUpdate.html">XResultSetUpdate</a></td> <td class="imsum_right"><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>is the interface for updating row data to the database. </dd> <dd><p>The optional support of this interface is already implied with the support of the ::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/ResultSet.html">ResultSet</a> service.</p> <p>However, note that the additional support of the <a href="XRowSetApproveBroadcaster.html">XRowSetApproveBroadcaster</a> interface results in a sematical extension: the methods ::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/XResultSetUpdate.html">XResultSetUpdate</a>::<a href="../sdbc/XResultSetUpdate.html#insertRow">insertRow</a>, ::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/XResultSetUpdate.html">XResultSetUpdate</a>::<a href="../sdbc/XResultSetUpdate.html#updateRow">updateRow</a> and ::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/XResultSetUpdate.html">XResultSetUpdate</a>::<a href="../sdbc/XResultSetUpdate.html#deleteRow">deleteRow</a> will now throw the <a href="RowSetVetoException.html">RowSetVetoException</a> if the action which is to be performed was vetoed by one of the <a href="XRowSetApproveListener.html">XRowSetApproveListener</a>'s.</p> </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../sdbcx/module-ix.html">sdbcx</a>::<a href="../sdbcx/XDeleteRows.html">XDeleteRows</a></td> <td class="imsum_right"><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>is the interface for deleting more than one row, identified by it's bookmark. </dd> <dd><p>The optional support of this interface is already implied with the support of the ::com::sun::star::<a href="../sdbcx/module-ix.html">sdbcx</a>::<a href="../sdbcx/ResultSet.html">ResultSet</a> service.</p> <p>However, note that the additional support of the <a href="XRowSetApproveBroadcaster.html">XRowSetApproveBroadcaster</a> interface results in a sematical extension: the method ::com::sun::star::<a href="../sdbcx/module-ix.html">sdbcx</a>::<a href="../sdbcx/XDeleteRows.html">XDeleteRows</a>::<a href="../sdbcx/XDeleteRows.html#deleteRows">deleteRows</a> will now throw the <a href="RowSetVetoException.html">RowSetVetoException</a> if the deletion was vetoed by one of the <a href="XRowSetApproveListener.html">XRowSetApproveListener</a>'s.</p> </dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="XResultSetAccess.html">XResultSetAccess</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>creates a second result set which is based on the same data. </dd> <dd><p> The new result set is interoperable with the row set which created it, e.g., you can exchange bookmarks between both sets. </p> <p> If the row set is not alive (i.e., it was not executed before), <b>NULL</b> is returned. </p> </dd> </dl> </td> </tr> <tr> <td class="imsum_left"><a href="XParametersSupplier.html">XParametersSupplier</a></td> <td class="imsum_right"><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>gives access to the parameters contained in the SQL statement represented by the component. </dd> <dd><p>If your <code>RowSet</code> is bound to an SQL command or query which contains parameters, or has a <a href="RowSet.html#Filter">Filter</a> or <a href="RowSet.html#Order">Order</a> which contains parameters, then those can be accessed using the <code>XParametersSupplier</code> interface.</p> <p>The returned container contains parameter objects which do allow write access to the parameters (which is equivalent to using the ::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/XParameters.html">XParameters</a> interface inherited from ::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/RowSet.html">RowSet</a>). Additionally, they provide information about the parameters, such as their name (if they have one), their type, and the like.</p> </dd> </dl> </td> </tr> </table> <a name="PropertiesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Properties' Summary</td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/XConnection.html">XConnection</a><br> <a href="#ActiveConnection">ActiveConnection</a></td> <td class="imsum_right">is the connection generated by a DataSource or by a URL. It could also be set from outside. When set from outside the RowSet is not responsible for the closing of the connection. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#DataSourceName">DataSourceName</a></td> <td class="imsum_right">is the name of the datasource to use, this could be a named datasource or the URL of a data access component. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#Command">Command</a></td> <td class="imsum_right">is the command which should be executed, the type of command depends on the CommandType. </td> </tr> <tr> <td class="imsum_left">long<br> <a href="#CommandType">CommandType</a></td> <td class="imsum_right">is the type of the command. </td> </tr> <tr> <td class="imsum_left">[ readonly ] string<br> <a href="#ActiveCommand">ActiveCommand</a></td> <td class="imsum_right">is the command which is currently used. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#IgnoreResult">IgnoreResult</a></td> <td class="imsum_right">indicates whether all results should be discarded or not. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#Filter">Filter</a></td> <td class="imsum_right">additional filter for a rowset. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#ApplyFilter">ApplyFilter</a></td> <td class="imsum_right">indicates whether the filter should be applied or not, default is <b>false</b>. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#HavingClause">HavingClause</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>additional having clause for the row set </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#GroupBy">GroupBy</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>additional group by for the row set </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#Order">Order</a></td> <td class="imsum_right">is a additional sort order definition for a rowset. </td> </tr> <tr> <td class="imsum_left">[ readonly ] long<br> <a href="#Privileges">Privileges</a></td> <td class="imsum_right">indicates the privileges for insert, update, and delete. </td> </tr> <tr> <td class="imsum_left">[ readonly ] boolean<br> <a href="#IsModified">IsModified</a></td> <td class="imsum_right">indicates that the current row is modified. </td> </tr> <tr> <td class="imsum_left">[ readonly ] boolean<br> <a href="#IsNew">IsNew</a></td> <td class="imsum_right">indicates that the current row is going to be inserted to the database. </td> </tr> <tr> <td class="imsum_left">[ readonly ] long<br> <a href="#RowCount">RowCount</a></td> <td class="imsum_right">contains the number of rows accessed in a the data source. </td> </tr> <tr> <td class="imsum_left">[ readonly ] boolean<br> <a href="#IsRowCountFinal">IsRowCountFinal</a></td> <td class="imsum_right">indicates that all rows of te row set have been counted. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#UpdateTableName">UpdateTableName</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>is the name of the table which should be updated, this is usually used for queries which relate to more than one table. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#UpdateCatalogName">UpdateCatalogName</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>is the name of the table catalog </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#UpdateSchemaName">UpdateSchemaName</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>is the name of the table schema. </td> </tr> </table> <a name="PropertiesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Properties' Details</td> </tr> <tr> <td class="imdetail"><a name="ActiveConnection" class="membertitle">ActiveConnection</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/XConnection.html">XConnection</a> <b>ActiveConnection</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>is the connection generated by a DataSource or by a URL. It could also be set from outside. When set from outside the RowSet is not responsible for the closing of the connection. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="DataSourceName" class="membertitle">DataSourceName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>DataSourceName</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>is the name of the datasource to use, this could be a named datasource or the URL of a data access component. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Command" class="membertitle">Command</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Command</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>is the command which should be executed, the type of command depends on the CommandType. </dd> <dd><p>In case of a <a href="#CommandType">CommandType</a> of <a href="CommandType.html">CommandType</a>::<a href="CommandType.html#COMMAND">COMMAND</a>, means in case the <a href="#Command">Command</a> specifies an SQL statement, the inherited ::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/RowSet.html">RowSet</a>::<a href="../sdbc/RowSet.html#EscapeProcessing">EscapeProcessing</a> becomes relevant:<br/> It then can be to used to specify whether the SQL statement should be analyzed on the client side before sending it to the database server.<br/> The default value for ::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/RowSet.html">RowSet</a>::<a href="../sdbc/RowSet.html#EscapeProcessing">EscapeProcessing</a> is <b>true</b>. By switching it to <b>false</b>, you can pass backend-specific SQL statements, which are not standard SQL, to your database.</p> </dd> <dt><b>See also</b></dt> <dd><a href="CommandType.html">CommandType</a>, ::com::sun::star::<a href="../sdbc/module-ix.html">sdbc</a>::<a href="../sdbc/RowSet.html">RowSet</a>::<a href="../sdbc/RowSet.html#EscapeProcessing">EscapeProcessing</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CommandType" class="membertitle">CommandType</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>CommandType</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>is the type of the command. </dd> <dt><b>See also</b></dt> <dd><a href="CommandType.html">CommandType</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ActiveCommand" class="membertitle">ActiveCommand</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] string <b>ActiveCommand</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>is the command which is currently used. </dd> <dt><b>See also</b></dt> <dd><a href="CommandType.html">CommandType</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="IgnoreResult" class="membertitle">IgnoreResult</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>IgnoreResult</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>indicates whether all results should be discarded or not. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Filter" class="membertitle">Filter</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Filter</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>additional filter for a rowset. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ApplyFilter" class="membertitle">ApplyFilter</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>ApplyFilter</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>indicates whether the filter should be applied or not, default is <b>false</b>. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="HavingClause" class="membertitle">HavingClause</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>HavingClause</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>additional having clause for the row set </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="GroupBy" class="membertitle">GroupBy</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>GroupBy</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>additional group by for the row set </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Order" class="membertitle">Order</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Order</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>is a additional sort order definition for a rowset. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Privileges" class="membertitle">Privileges</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] long <b>Privileges</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>indicates the privileges for insert, update, and delete. </dd> <dt><b>See also</b></dt> <dd>::com::sun::star::<a href="../sdbcx/module-ix.html">sdbcx</a>::<a href="../sdbcx/Privilege.html">Privilege</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="IsModified" class="membertitle">IsModified</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] boolean <b>IsModified</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>indicates that the current row is modified. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="IsNew" class="membertitle">IsNew</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] boolean <b>IsNew</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>indicates that the current row is going to be inserted to the database. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="RowCount" class="membertitle">RowCount</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] long <b>RowCount</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains the number of rows accessed in a the data source. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="IsRowCountFinal" class="membertitle">IsRowCountFinal</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ readonly ] boolean <b>IsRowCountFinal</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>indicates that all rows of te row set have been counted. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="UpdateTableName" class="membertitle">UpdateTableName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>UpdateTableName</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>is the name of the table which should be updated, this is usually used for queries which relate to more than one table. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="UpdateCatalogName" class="membertitle">UpdateCatalogName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>UpdateCatalogName</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>is the name of the table catalog </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="UpdateSchemaName" class="membertitle">UpdateSchemaName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>UpdateSchemaName</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>is the name of the table schema. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <br> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
5024
