xref: /aoo41x/main/offapi/com/sun/star/rdf/XQuerySelectResult.idl (revision 96af39f7)

/**************************************************************
 *
 * 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_rdf_XQuerySelectResult_idl__
#define __com_sun_star_rdf_XQuerySelectResult_idl__

#ifndef __com_sun_star_container_XEnumeration_idl__
#include <com/sun/star/container/XEnumeration.idl>
#endif


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

module com {   module sun {   module star {   module rdf {

//=============================================================================
/** represents the result of a SPARQL "SELECT" query.

    <p>
    The result consists of:
    <ol>
    <li>a list of query variable names (column labels)</li>
    <li>an iterator of query results (rows),
        each being a list of bindings for the above variables</li>
    </ol>
    Note that each query result retrieved via
    <member scope="com::sun::star::container">XEnumeration::nextElement</member>
    has the type <type dim="[]">XNode</type>,
    the length of the sequence being the same as the number of query variables.
    </p>

    @since OpenOffice 3.0

    @see XRepository::querySelect
    @see XNode
 */
interface XQuerySelectResult : com::sun::star::container::XEnumeration
{
    //-------------------------------------------------------------------------
    /** get the names of the query variables.

        <p>
        </p>
     */
     sequence<string> getBindingNames();
};

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

}; }; }; };

#endif