xref: /aoo41x/main/offapi/com/sun/star/sdbcx/XRowLocate.idl (revision d1766043)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_sdbcx_XRowLocate_idl__
#define __com_sun_star_sdbcx_XRowLocate_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_sdbc_SQLException_idl__
#include <com/sun/star/sdbc/SQLException.idl>
#endif

 module com {  module sun {  module star {  module sdbcx {


/** is used to identify rows within a result set and to find rows by a bookmark.


	<p>
	Bookmarks are only valid in the scope of the current result set and
	are not interchangeable between result sets. A bookmark could be a complex data
	structure, so it could not be compared in a safe way. Because of that, a provider
	has to implement the compare method for bookmarks.
	</p>
 */
published interface XRowLocate: com::sun::star::uno::XInterface
{

	/** returns the bookmark of the current row of a result set.
		@returns
			the current bookmark
		@throws com::sun::star::sdbc::SQLException
			if a database access error occurs.
	 */
	any getBookmark() raises (com::sun::star::sdbc::SQLException);
	//-------------------------------------------------------------------------

	/** moves the cursor to the row identified by an valid bookmark.

		<p>
		If the bookmark could not be located, a result set will be positioned
		after the last record.
		<br/>
		If the bookmark is invalid, or not generated by the current result set, then
		the behaviour is not defined, even an abnormal termination is possible.
		</p>
		@param bookmark
			the bookmark where to move
		@returns
			<TRUE/> if successful
		@throws com::sun::star::sdbc::SQLException
			if a database access error occurs.
	 */
	boolean moveToBookmark([in]any bookmark) raises (com::sun::star::sdbc::SQLException);
    //-------------------------------------------------------------------------

	/** moves the cursor a relative number of rows, either positive or negative
		starting at a given bookmark position.


		<p>
		If the bookmark could not be located, a result set will be positioned
		after the last record.
		<br/>
		If the bookmark is invalid, or not generated by the current result set, then
		the behaviour is not defined, even an abnormal termination is possible.
		</p>
		@param bookmark
			the bookmark where to move
		@param rows
			count of rows move relative to the bookmark
		@returns
			<TRUE/> if successful
		@throws com::sun::star::sdbc::SQLException
			if a database access error occurs.
	 */
	boolean moveRelativeToBookmark([in]any bookmark, [in]long rows)
		raises (com::sun::star::sdbc::SQLException);
	//-------------------------------------------------------------------------

	/** compares two bookmarks and returns an indication of their relative values.

		<p>
		The bookmarks must apply to the same ResultSet. You cannot reliably
		compare bookmarks from different ResultSets, even if they were created from
		the same source or statement.
		<br/>
		A bookmark that is not valid, or incorrectly formed, will cause an exception.
		</p>
		@param first
			the first bookmark
		@param second
			the second bookmark
		@returns
			a value of <type scope="com::sun::star::sdbcx">CompareBookmark</type>
		@throws com::sun::star::sdbc::SQLException
			if a database access error occurs.

		@see com::sun::star::sdbcx::CompareBookmark

	 */
	long compareBookmarks([in]any first, [in]any second)
		raises (com::sun::star::sdbc::SQLException);
    //-------------------------------------------------------------------------

	/** determines whether the bookmarks of a result set are ordered or not.
		@returns
			<TRUE/> if so
		@throws com::sun::star::sdbc::SQLException
			if a database access error occurs.
		@see com::sun::star::sdbcx::CompareBookmark
	 */
	boolean hasOrderedBookmarks() raises (com::sun::star::sdbc::SQLException);
    //-------------------------------------------------------------------------

	/** returns the hash value for a specified bookmark.
		@param bookmark
			the bookmark to hash
		@returns
			the hashed value
		@throws com::sun::star::sdbc::SQLException
			if a database access error occurs.
	 */
	long hashBookmark([in]any bookmark) raises (com::sun::star::sdbc::SQLException);
};

//=============================================================================

}; }; }; };

/*===========================================================================
===========================================================================*/
#endif