INTEGRATION: CWS eforms2 (1.1.2); FILE ADDED

2004/11/05 17:50:11 fs 1.1.2.8: #i36765# allow submission with InteractionHandler
2004/07/12 14:11:55 fs 1.1.2.7: #114856# introduced and used XSubmission
2004/06/09 08:24:46 dvo 1.1.2.6: #114856# Solaris compiler problems
(typedef names in throw clauses; include-before-forward-declaration)
Issue number:
Submitted by:
Reviewed by:
2004/06/04 13:37:16 dvo 1.1.2.5: #114856# solve compilation problems uncovered with gcc
Issue number:
Submitted by:
Reviewed by:
2004/04/23 14:04:47 lo 1.1.2.4: #i26721# put/get/post support
2004/04/23 09:46:16 lo 1.1.2.3: #i26721# put/get/post support for submission
2004/04/06 11:18:16 lo 1.1.2.2: #114856# submission cont.
2004/04/01 11:24:37 dvo 1.1.2.1: #114856# add submission
Issue number:
Submitted by:
Reviewed by:

1 files changed, 317 insertions, 0 deletions

diff --git a/forms/source/xforms/submission.hxx b/forms/source/xforms/submission.hxx
new file mode 100644
index 000000000000..20a24b645a79
--- /dev/null
+++ b/forms/source/xforms/submission.hxx
@@ -0,0 +1,317 @@
+/*************************************************************************
+ *
+ *  $RCSfile: submission.hxx,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: obo $ $Date: 2004-11-16 10:57:00 $
+ *
+ *  The Contents of this file are made available subject to the terms of
+ *  either of the following licenses
+ *
+ *         - GNU Lesser General Public License Version 2.1
+ *         - Sun Industry Standards Source License Version 1.1
+ *
+ *  Sun Microsystems Inc., October, 2000
+ *
+ *  GNU Lesser General Public License Version 2.1
+ *  =============================================
+ *  Copyright 2000 by Sun Microsystems, Inc.
+ *  901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public
+ *  License version 2.1, as published by the Free Software Foundation.
+ *
+ *  This library is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *  Lesser General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public
+ *  License along with this library; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *  MA  02111-1307  USA
+ *
+ *
+ *  Sun Industry Standards Source License Version 1.1
+ *  =================================================
+ *  The contents of this file are subject to the Sun Industry Standards
+ *  Source License Version 1.1 (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.openoffice.org/license.html.
+ *
+ *  Software provided under this License is provided on an "AS IS" basis,
+ *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ *  See the License for the specific provisions governing your rights and
+ *  obligations concerning the Software.
+ *
+ *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ *  Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ *  All Rights Reserved.
+ *
+ *  Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+
+#ifndef _SUBMISSION_HXX
+#define _SUBMISSION_HXX
+
+
+// includes for parent classes
+#include <cppuhelper/implbase2.hxx>
+#include <propertysetbase.hxx>
+#include <com/sun/star/util/XModifyBroadcaster.hpp>
+#include <com/sun/star/container/XNamed.hpp>
+#include <com/sun/star/xml/dom/events/XEventListener.hpp>
+#include <com/sun/star/lang/XUnoTunnel.hpp>
+#include <com/sun/star/xml/dom/XNode.hpp>
+#include <com/sun/star/xml/dom/XDocument.hpp>
+#include <com/sun/star/xml/dom/XDocumentFragment.hpp>
+#include <com/sun/star/xml/xpath/XXPathObject.hpp>
+#include <com/sun/star/xforms/XSubmission.hpp>
+
+// includes for member variables
+#include <com/sun/star/uno/Reference.hxx>
+#include <com/sun/star/uno/Sequence.hxx>
+#include <computedexpression.hxx>
+#include <com/sun/star/lang/XMultiServiceFactory.hpp>
+
+// forward declaractions
+namespace com { namespace sun { namespace star {
+    namespace xforms { class XModel; }
+    namespace uno { class Any; }
+    namespace beans { class UnknownPropertyException;
+                      class PropertyVetoException; }
+    namespace lang { class IllegalArgumentException;
+                     class WrappedTargetException; }
+} } }
+namespace xforms { class Model; }
+namespace comphelper { class PropertySetInfo; }
+
+
+
+namespace xforms
+{
+
+/** An XForms submission.
+ *
+ * See http://www.w3.org/TR/xforms/ for more information.
+ */
+typedef cppu::ImplInheritanceHelper2<
+    PropertySetBase,
+    com::sun::star::lang::XUnoTunnel,
+    com::sun::star::xforms::XSubmission
+> Submission_t;
+
+class Submission : public Submission_t
+{
+    // submission properties
+    rtl::OUString msID;
+    rtl::OUString msBind;
+    ComputedExpression maRef;
+    rtl::OUString msAction;
+    rtl::OUString msMethod;
+    rtl::OUString msVersion;
+    bool mbIndent;
+    rtl::OUString msMediaType;
+    rtl::OUString msEncoding;
+    bool mbOmitXmlDeclaration;
+    bool mbStandalone;
+    rtl::OUString msCDataSectionElement;
+    rtl::OUString msReplace;
+    rtl::OUString msSeparator;
+    com::sun::star::uno::Sequence< rtl::OUString > msIncludeNamespacePrefixes;
+
+private:
+
+    /// the Model to which this Submission belongs; may be NULL
+    com::sun::star::uno::Reference<com::sun::star::xforms::XModel> mxModel;
+
+    // this will extract the document from the model that will be submitted
+    com::sun::star::uno::Reference< com::sun::star::xml::dom::XDocumentFragment >
+        createSubmissionDocument(const com::sun::star::uno::Reference< com::sun::star::xml::xpath::XXPathObject >& aObject,
+                                 sal_Bool bRemoveWSNodes = sal_False);
+
+    com::sun::star::uno::Reference<com::sun::star::lang::XMultiServiceFactory > m_aFactory;
+public:
+    Submission();
+    virtual ~Submission() throw();
+
+    //
+    // property methods: get/set value
+    //
+
+    /// get XForms model
+    com::sun::star::uno::Reference<com::sun::star::xforms::XModel>
+        getModel() const;
+
+    /// set XForms model
+    void setModel(
+        const com::sun::star::uno::Reference<com::sun::star::xforms::XModel>& );
+
+    rtl::OUString getID() const;         /// get ID for this submission
+    void setID( const rtl::OUString& );  /// set ID for this submission
+
+    rtl::OUString getBind() const;
+    void setBind( const rtl::OUString& );
+
+    rtl::OUString getRef() const;
+    void setRef( const rtl::OUString& );
+
+    rtl::OUString getAction() const;
+    void setAction( const rtl::OUString& );
+
+    rtl::OUString getMethod() const;
+    void setMethod( const rtl::OUString& );
+
+    rtl::OUString getVersion() const;
+    void setVersion( const rtl::OUString& );
+
+    bool getIndent() const;
+    void setIndent( bool );
+
+    rtl::OUString getMediaType() const;
+    void setMediaType( const rtl::OUString& );
+
+    rtl::OUString getEncoding() const;
+    void setEncoding( const rtl::OUString& );
+
+    bool getOmitXmlDeclaration() const;
+    void setOmitXmlDeclaration( bool );
+
+    bool getStandalone() const;
+    void setStandalone( bool );
+
+    rtl::OUString getCDataSectionElement() const;
+    void setCDataSectionElement( const rtl::OUString& );
+
+    rtl::OUString getReplace() const;
+    void setReplace( const rtl::OUString& );
+
+    rtl::OUString getSeparator() const;
+    void setSeparator( const rtl::OUString& );
+
+    com::sun::star::uno::Sequence< rtl::OUString > getIncludeNamespacePrefixes() const;
+    void setIncludeNamespacePrefixes( const rtl::OUString& );
+
+
+    /** perform the submission
+     * @returns if submission was successful */
+    bool doSubmit( const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionHandler >& aHandler );
+
+
+    /// release the model (note: Binding is unusable without model)
+    void releaseModel();
+
+
+    // helpers for UNO tunnel
+    static com::sun::star::uno::Sequence<sal_Int8> getUnoTunnelID();
+    static Submission* getSubmission( const com::sun::star::uno::Reference<com::sun::star::beans::XPropertySet>& );
+
+
+
+private:
+
+    /// check whether object is live, and throw suitable exception if not
+    /// (to be used be API methods before acting on the object)
+    void liveCheck()
+        throw( com::sun::star::uno::RuntimeException );
+
+    /// get the model implementation
+    xforms::Model* getModelImpl() const;
+    xforms::Model* getModelImpl( const com::sun::star::uno::Reference<com::sun::star::xforms::XModel>& xModel ) const;
+
+
+
+protected:
+
+    //
+    // XPropertySet & friends:
+    //   implement abstract methods from PropertySetHelper
+    //
+
+    virtual void _setPropertyValues(
+        const comphelper::PropertyMapEntry** ppEntries,
+        const com::sun::star::uno::Any* pValues )
+        throw( com::sun::star::beans::UnknownPropertyException,
+               com::sun::star::beans::PropertyVetoException,
+               com::sun::star::lang::IllegalArgumentException,
+               com::sun::star::lang::WrappedTargetException );
+
+    virtual void _getPropertyValues(
+        const comphelper::PropertyMapEntry** ppEntries,
+        com::sun::star::uno::Any* pValue )
+        throw( com::sun::star::beans::UnknownPropertyException,
+               com::sun::star::lang::WrappedTargetException );
+
+private:
+    static comphelper::PropertySetInfo* _getPropertySetInfo();
+
+
+public:
+
+    //
+    // XNamed:
+    //   get/set name
+    //
+
+    virtual rtl::OUString SAL_CALL getName()
+        throw( com::sun::star::uno::RuntimeException );
+
+    virtual void SAL_CALL setName( const rtl::OUString& )
+        throw( com::sun::star::uno::RuntimeException );
+
+
+
+    //
+    // XUnoTunnel
+    //
+
+    virtual sal_Int64 SAL_CALL getSomething(
+        const com::sun::star::uno::Sequence<sal_Int8>& )
+        throw( com::sun::star::uno::RuntimeException );
+
+
+    //
+    // XSubmission
+    //
+
+    virtual void SAL_CALL submit(  )
+        throw ( com::sun::star::util::VetoException,
+                com::sun::star::lang::WrappedTargetException,
+                com::sun::star::uno::RuntimeException );
+    virtual void SAL_CALL submitWithInteraction(
+        const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionHandler >& aHandler )
+        throw ( com::sun::star::util::VetoException,
+                com::sun::star::lang::WrappedTargetException,
+                com::sun::star::uno::RuntimeException );
+    virtual void SAL_CALL addSubmissionVetoListener(
+        const ::com::sun::star::uno::Reference< ::com::sun::star::form::submission::XSubmissionVetoListener >& listener )
+        throw (::com::sun::star::lang::NoSupportException, ::com::sun::star::uno::RuntimeException);
+    virtual void SAL_CALL removeSubmissionVetoListener(
+        const ::com::sun::star::uno::Reference< ::com::sun::star::form::submission::XSubmissionVetoListener >& listener )
+        throw (::com::sun::star::lang::NoSupportException, ::com::sun::star::uno::RuntimeException);
+
+    //
+    // XPropertySet
+    // (need to disambiguate this)
+
+    virtual ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo(  ) throw(::com::sun::star::uno::RuntimeException);
+    virtual void SAL_CALL setPropertyValue( const ::rtl::OUString& aPropertyName, const ::com::sun::star::uno::Any& aValue ) throw(::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::beans::PropertyVetoException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
+    virtual ::com::sun::star::uno::Any SAL_CALL getPropertyValue( const ::rtl::OUString& PropertyName ) throw(::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
+    virtual void SAL_CALL addPropertyChangeListener( const ::rtl::OUString& aPropertyName, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertyChangeListener >& xListener ) throw(::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
+    virtual void SAL_CALL removePropertyChangeListener( const ::rtl::OUString& aPropertyName, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertyChangeListener >& aListener ) throw(::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
+    virtual void SAL_CALL addVetoableChangeListener( const ::rtl::OUString& PropertyName, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XVetoableChangeListener >& aListener ) throw(::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
+    virtual void SAL_CALL removeVetoableChangeListener( const ::rtl::OUString& PropertyName, const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XVetoableChangeListener >& aListener ) throw(::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
+};
+
+
+} // namespace xforms
+
+#endif