diff options
Diffstat (limited to 'offapi/com/sun/star/sdbc/XArray.idl')
| -rw-r--r-- | offapi/com/sun/star/sdbc/XArray.idl | 132 |
1 files changed, 106 insertions, 26 deletions
diff --git a/offapi/com/sun/star/sdbc/XArray.idl b/offapi/com/sun/star/sdbc/XArray.idl index 40bb29f5a75d..914b03175927 100644 --- a/offapi/com/sun/star/sdbc/XArray.idl +++ b/offapi/com/sun/star/sdbc/XArray.idl @@ -2,9 +2,9 @@ * * $RCSfile: XArray.idl,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: jsc $ $Date: 2001-03-16 16:41:35 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:06:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -79,9 +79,16 @@ interface XResultSet; // DocMerge from xml: interface com::sun::star::container::com::sun::star::sdbc::XArray -/** is used for mapping the SQL type <code>ARRAY</code>. - By default, an <code>Array</code> is a transaction duration - reference to an SQL array. By default, an <code>Array</code> +/** is used for mapping the SQL type + <member scope= "com::sun::star::sdbc">DataType::ARRAY</member> + . + By default, an + <code>Array</code> + is a transaction duration + reference to an SQL array. By default, an + + <code>Array</code> + is implemented using a SQL LOCATOR(array) internally. */ interface XArray: com::sun::star::uno::XInterface @@ -89,15 +96,20 @@ interface XArray: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XArray::getBaseTypeName /** returns the SQL type name of the elements in - the array designated by this <code>Array</code> object. - - - <p>If the elements are a built-in type, it returns + the array designated by this + <code>Array</code> + object. + <p> + If the elements are a built-in type, it returns the database-specific type name of the elements. If the elements are a user-defined type (UDT), this method returns the fully-qualified SQL type name. - </p> + @returns + a String that is the database-specific name for a built-in base type or the fully-qualified SQL type name for a base type that is a UDT + + @throws SQLException + if a database access error occurs. */ string getBaseTypeName() raises (SQLException); @@ -105,7 +117,13 @@ interface XArray: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XArray::getBaseType /** returns the SDBC type of the elements in the array designated - by this <code>Array</code> object. + by this + <code>Array</code> + object. + @returns + a constant from the SDBC types that is the type code for the elements in the array designated by this Array object. + @throws SQLException + if a database access error occurs. */ long getBaseType() raises (SQLException); @@ -113,14 +131,23 @@ interface XArray: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::container::com::sun::star::sdbc::XArray::getArray /** retrieves the contents of the SQL array designated by this - <code>Array</code> object, using the specified <code>typeMap</code> + <code>Array</code> + object, using the specified + <code>typeMap</code> for type map customizations. - <p>If the base type of the array does not match a user-defined type - in <code>typeMap</code>, the standard mapping is used instead. + <p> + If the base type of the array does not match a user-defined type + in + <code>typeMap</code> + , the standard mapping is used instead. @param typeMap is a map object that contains mappings of SQL type names to - services. If the <code>typeMap</code> is <NULL/>, the type-map + services. If the + <code>typeMap</code> + is + <NULL/> + , the type-map associated with the connection for customizations of the type-mappings is used. @@ -138,7 +165,10 @@ interface XArray: com::sun::star::uno::XInterface // DocMerge from idl: method com::sun::star::container::com::sun::star::sdbc::XArray::getArrayAtIndex /** returns an array containing a slice of the SQL array, beginning with the - specified <code>index</code> and containing up to <code>count</code> + specified + <code>index</code> + and containing up to + <code>count</code> successive elements of the SQL array. @param index @@ -148,12 +178,20 @@ interface XArray: com::sun::star::uno::XInterface is the number of successive SQL array elements to retrieve. @param typeMap is a map object that contains mappings of SQL type names to - services. If the <code>typeMap</code> is <NULL/>, the type-map + services. If the + <code>typeMap</code> + is + <NULL/> + , the type-map associated with the connection for customizations of the type-mappings is used. @returns - an array containing up to <code>count</code> consecutive elements - of the SQL array, beginning with element <code>index</code>. + an array containing up to + <code>count</code> + consecutive elements + of the SQL array, beginning with element + <code>index</code> + . @throws SQLException if an error occurs while attempting to access the array. */ @@ -167,10 +205,18 @@ interface XArray: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XArray::getResultSet /** returns a result set that contains the elements of the array - designated by this <code>Array</code> object and uses the given - <code>typeMap</code> to map the array elements. If the base + designated by this + <code>Array</code> + object and uses the given + <code>typeMap</code> + to map the array elements. If the base type of the array does not match a user-defined type in - <code>typeMap</code> or the <code>typeMap</code> is <NULL/>, + <code>typeMap</code> + or the + <code>typeMap</code> + is + <NULL/> + , the connection type mapping is used instead. @@ -182,6 +228,14 @@ interface XArray: com::sun::star::uno::XInterface The rows are in ascending order corresponding to the order of the indices. </p> + + @param typeMap + contains mapping of SQL user-defined types to classes in the UNO programming language + @returns + a ResultSet object containing one row for each of the elements in the array designated by this Array object, + with the rows in ascending order based on the indices. + @throws SQLException + if a database access error occurs. */ XResultSet getResultSet([in]com::sun::star::container::XNameAccess typeMap) raises (SQLException); @@ -190,11 +244,20 @@ interface XArray: com::sun::star::uno::XInterface // DocMerge from xml: method com::sun::star::container::com::sun::star::sdbc::XArray::getResultSetAtIndex /** returns a result set holding the elements of the subarray that - starts at index <code>index</code> and contains up to - <code>count</code> successive elements. This method uses the given - <code>typeMap</code> to map the array elements. If the base + starts at index + <code>index</code> + and contains up to + <code>count</code> + successive elements. This method uses the given + <code>typeMap</code> + to map the array elements. If the base type of the array does not match a user-defined type in - <code>typeMap</code> or the <code>typeMap</code> is <NULL/>, + <code>typeMap</code> + or the + <code>typeMap</code> + is + <NULL/> + , the connection type mapping is used instead. @@ -206,6 +269,17 @@ interface XArray: com::sun::star::uno::XInterface The rows are in ascending order corresponding to the order of the indices. </p> + @param index + the array index of the first element to retrieve; the first element is at index 1. + @param count + the number of successive SQL array elements to retrieve, + @param typeMap + the Map object that contains the mapping of SQL type names to classes in the UNO programming language. + @returns + a ResultSet object containing up to count consecutive elements of the SQL array + designated by this Array object, starting at index index. + @throws SQLException + if a database access error occurs. */ XResultSet getResultSetAtIndex([in]long index, [in]long count, @@ -219,6 +293,12 @@ interface XArray: com::sun::star::uno::XInterface /*=========================================================================== $Log: not supported by cvs2svn $ + Revision 1.5.16.1 2002/02/18 09:00:56 oj + #97563# parameter,return value and exception description + + Revision 1.5 2001/03/16 16:41:35 jsc + remove interfaceheader with uik and remove [const] in method definitions + Revision 1.4 2000/12/19 13:46:04 mi syntax errors in documentation fixed |