summaryrefslogtreecommitdiffstats
path: root/forms/source/component/cachedrowset.hxx
diff options
context:
space:
mode:
Diffstat (limited to 'forms/source/component/cachedrowset.hxx')
-rw-r--r--forms/source/component/cachedrowset.hxx78
1 files changed, 78 insertions, 0 deletions
diff --git a/forms/source/component/cachedrowset.hxx b/forms/source/component/cachedrowset.hxx
new file mode 100644
index 000000000..f87ee2c07
--- /dev/null
+++ b/forms/source/component/cachedrowset.hxx
@@ -0,0 +1,78 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * 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 .
+ */
+
+#pragma once
+
+#include <com/sun/star/sdbc/XResultSet.hpp>
+#include <com/sun/star/sdbc/XConnection.hpp>
+
+#include <memory>
+
+
+namespace frm
+{
+
+ struct CachedRowSet_Data;
+
+ /// caches a result set obtained from a SQL statement
+ class CachedRowSet
+ {
+ public:
+ CachedRowSet();
+ ~CachedRowSet();
+
+ public:
+ /** executes the statement
+
+ @return
+ the result set produced by the statement. The caller takes ownership of the
+ given object.
+
+ @throws css::sdbc::SQLException
+ if such an exception is thrown when executing the statement
+ */
+ css::uno::Reference< css::sdbc::XResultSet >
+ execute();
+
+ /// determines whether the row set properties are dirty, i.e. have changed since the last call to execute
+ bool isDirty() const;
+
+ /// disposes the instance and frees all associated resources
+ void dispose();
+
+ /** sets the command of a query as command to be executed
+
+ A connection must have been set before.
+
+ @throws Exception
+ */
+ void setCommandFromQuery ( const OUString& _rQueryName );
+
+ void setCommand ( const OUString& _rCommand );
+ void setEscapeProcessing ( const bool _bEscapeProcessing );
+ void setConnection ( const css::uno::Reference< css::sdbc::XConnection >& _rxConnection );
+
+ private:
+ ::std::unique_ptr< CachedRowSet_Data > m_pData;
+ };
+
+
+} // namespace frm
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */