ucb/source/ucp/hierarchy/hierarchydatasupplier.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: hierarchydatasupplier.hxx,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef _HIERARCHYDATASUPPLIER_HXX
  32 #define _HIERARCHYDATASUPPLIER_HXX
  33
  34 #include <rtl/ref.hxx>
  35 #include <com/sun/star/ucb/OpenMode.hpp>
  36 #include <ucbhelper/resultset.hxx>
  37
  38 namespace hierarchy_ucp {
  39
  40 class HierarchyEntryData;
  41 struct DataSupplier_Impl;
  42 class HierarchyContent;
  43
  44 class HierarchyResultSetDataSupplier :
  45         public ::ucbhelper::ResultSetDataSupplier
  46 {
  47     DataSupplier_Impl*  m_pImpl;
  48
  49 private:
  50     sal_Bool checkResult( const HierarchyEntryData& rResult );
  51
  52 public:
  53     HierarchyResultSetDataSupplier(
  54                     const com::sun::star::uno::Reference<
  55                         com::sun::star::lang::XMultiServiceFactory >& rxSMgr,
  56                     const rtl::Reference< HierarchyContent >& rContent,
  57                     sal_Int32 nOpenMode = com::sun::star::ucb::OpenMode::ALL );
  58     virtual ~HierarchyResultSetDataSupplier();
  59
  60     virtual rtl::OUString queryContentIdentifierString( sal_uInt32 nIndex );
  61     virtual com::sun::star::uno::Reference<
  62                 com::sun::star::ucb::XContentIdentifier >
  63     queryContentIdentifier( sal_uInt32 nIndex );
  64     virtual com::sun::star::uno::Reference< com::sun::star::ucb::XContent >
  65     queryContent( sal_uInt32 nIndex );
  66
  67     virtual sal_Bool getResult( sal_uInt32 nIndex );
  68
  69     virtual sal_uInt32 totalCount();
  70     virtual sal_uInt32 currentCount();
  71     virtual sal_Bool isCountFinal();
  72
  73     virtual com::sun::star::uno::Reference< com::sun::star::sdbc::XRow >
  74     queryPropertyValues( sal_uInt32 nIndex  );
  75     virtual void releasePropertyValues( sal_uInt32 nIndex );
  76
  77     virtual void close();
  78
  79     virtual void validate()
  80         throw( com::sun::star::ucb::ResultSetException );
  81 };
  82
  83 } // namespace hierarchy_ucp
  84
  85 #endif /* !_HIERARCHYDATASUPPLIER_HXX */