service ContentResultSet in module com::sun::star::ucb::

(Global Index)

Syntax

service ContentResultSet;

Description

provides access to the children of a folder content.

It can be understand as a table containing a row for each child. The table columns may contain values of properties of the children.

Included Services

com::sun::star::sdbc::ResultSet

Description

can be implemented to provide a complete JDBC conform result set interface for the implementation of this service.

The implememtation of this service is optional.


Exported Interfaces

com::sun::star::lang::XComponent

Description

must be implemented to make it possible to resolve cyclic object references ( i.e. between an implementation of XPropertySet - which may hold property change listeners - and XPropertyChangeListener - which may hold the property set ).

This interface is required.


com::sun::star::sdbc::XResultSetMetaDataSupplier

Description

provides access to the result set meta data. Meta data are for example the number of columns of the result set, information on the data types of columns, column names, and more.

This interface is required.


com::sun::star::sdbc::XResultSet

Description

enables travelling through the result set members ( the contents ). This interface mainly provides a cursor for the result set.

Note that every method of this interface implementation additionally may throw a ResultSetException ( which is derived from SQLException to be compatible to that interface ). The new exception transports another exception, which indicates the reason for the failure of the method call.

This interface is required.


com::sun::star::sdbc::XRow

Description

provides access to data of the content the cursor is pointing to.

Note that every method of this interface implementation additionally may throw a ResultSetException ( which is derived from SQLException to be compatible to that interface ). The new exception transports another exception, which indicates the reason for the failure of the method call.

This interface is required.


com::sun::star::sdbc::XCloseable

Description

makes it possible to abort running activities ( i.e. to cancel retrieving data from a server ).

Note that every method of this interface implementation additionally may throw a ResultSetException ( which is derived from SQLException to be compatible to that interface ). The new exception transports another exception, which indicates the reason for the failure of the method call.

This interface is required.


com::sun::star::beans::XPropertySet

Description

holds properties of the resultset.

This interface is required.


com::sun::star::ucb::XContentAccess

Description

provides access to the content identifier and the content object itself.

This interface is required.


Property Summary

CursorTravelMode controls the travel mode of the resultset cursor.

RowCount contains the number of rows obtained (so far) from the data source.

IsRowCountFinal indicates that all rows of te resultset have been obtained.

Property Details



CursorTravelMode [ O P T I O N A L ]

Syntax

long CursorTravelMode;

Description

controls the travel mode of the resultset cursor.

There are two possible travel modes:

CursorTravelMode::BLOCKING Each travel method of the resultset will not return until the data for the new position were retrieved.
CursorTravelMode::NONBLOCKING The implementation will throw a CursorWouldBlockException , if the data for the new position are not retrieved yet.

The following pseudo-code illustrates the usage of a non-blocking cursor:

 bProcessedAllRows = false
 while ( !bProcessedAllRows )
 {
 cursor.setPropertyValue( "CursorTravelMode", BLOCKING )

 cursor.travelSomeWhere()
 collectRowData()

 cursor.setPropertyValue( "CursorTravelMode", NONBLOCKING )

 bGoOn = true;
 while ( bGoOn )
 {
 try
 {
 cursor.travelSomeWhere()
 collectRowData()
 }
 catch ( CursorWouldBlockException )
 {
 // No more data at the moment.
 bGoOn = false
 }
 }

 doSomethingWithCollectedRowData()

 bProcessedAllRows = ...
 }

If this property is not supported, the implementation needs to provide a blocking cursor.

The implementation initially needs to set the value of this property to CursorTravelMode::BLOCKING .

See also

CursorTravelMode

RowCount

Syntax

[readonly] long RowCount;

Description

contains the number of rows obtained (so far) from the data source.


IsRowCountFinal

Syntax

[readonly] boolean IsRowCountFinal;

Description

indicates that all rows of te resultset have been obtained.

Top of Page