forms/source/xforms/submission.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: submission.hxx,v $
  10  * $Revision: 1.5 $
  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 _SUBMISSION_HXX
  32 #define _SUBMISSION_HXX
  33
  34
  35 // includes for parent classes
  36 #include <cppuhelper/implbase2.hxx>
  37 #include <propertysetbase.hxx>
  38 #include <com/sun/star/util/XModifyBroadcaster.hpp>
  39 #include <com/sun/star/container/XNamed.hpp>
  40 #include <com/sun/star/xml/dom/events/XEventListener.hpp>
  41 #include <com/sun/star/lang/XUnoTunnel.hpp>
  42 #include <com/sun/star/xml/dom/XNode.hpp>
  43 #include <com/sun/star/xml/dom/XDocument.hpp>
  44 #include <com/sun/star/xml/dom/XDocumentFragment.hpp>
  45 #include <com/sun/star/xml/xpath/XXPathObject.hpp>
  46 #include <com/sun/star/xforms/XSubmission.hpp>
  47
  48 // includes for member variables
  49 #include <com/sun/star/uno/Reference.hxx>
  50 #include <com/sun/star/uno/Sequence.hxx>
  51 #include <computedexpression.hxx>
  52 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  53
  54 // forward declaractions
  55 namespace com { namespace sun { namespace star {
  56     namespace xforms { class XModel; }
  57     namespace uno { class Any; }
  58     namespace beans { class UnknownPropertyException;
  59                       class PropertyVetoException; }
  60     namespace lang { class IllegalArgumentException;
  61                      class WrappedTargetException; }
  62 } } }
  63 namespace xforms { class Model; }
  64
  65
  66 namespace xforms
  67 {
  68
  69 /** An XForms submission.
  70  *
  71  * See http://www.w3.org/TR/xforms/ for more information.
  72  */
  73 typedef cppu::ImplInheritanceHelper2<
  74     PropertySetBase,
  75     com::sun::star::lang::XUnoTunnel,
  76     com::sun::star::xforms::XSubmission
  77 > Submission_t;
  78
  79 class Submission : public Submission_t
  80 {
  81     // submission properties
  82     rtl::OUString msID;
  83     rtl::OUString msBind;
  84     ComputedExpression maRef;
  85     rtl::OUString msAction;
  86     rtl::OUString msMethod;
  87     rtl::OUString msVersion;
  88     bool mbIndent;
  89     rtl::OUString msMediaType;
  90     rtl::OUString msEncoding;
  91     bool mbOmitXmlDeclaration;
  92     bool mbStandalone;
  93     rtl::OUString msCDataSectionElement;
  94     rtl::OUString msReplace;
  95     rtl::OUString msSeparator;
  96     com::sun::star::uno::Sequence< rtl::OUString > msIncludeNamespacePrefixes;
  97
  98 private:
  99
 100     /// the Model to which this Submission belongs; may be NULL
 101     com::sun::star::uno::Reference<com::sun::star::xforms::XModel> mxModel;
 102
 103     // this will extract the document from the model that will be submitted
 104     com::sun::star::uno::Reference< com::sun::star::xml::dom::XDocumentFragment >
 105         createSubmissionDocument(const com::sun::star::uno::Reference< com::sun::star::xml::xpath::XXPathObject >& aObject,
 106                                  sal_Bool bRemoveWSNodes = sal_False);
 107     com::sun::star::uno::Reference< com::sun::star::xml::dom::XDocument >
 108         getInstanceDocument(const com::sun::star::uno::Reference< com::sun::star::xml::xpath::XXPathObject >& aObject);
 109
 110     com::sun::star::uno::Reference<com::sun::star::lang::XMultiServiceFactory > m_aFactory;
 111 public:
 112     Submission();
 113     virtual ~Submission() throw();
 114
 115     //
 116     // property methods: get/set value
 117     //
 118
 119     /// get XForms model
 120     com::sun::star::uno::Reference<com::sun::star::xforms::XModel>
 121         getModel() const;
 122
 123     /// set XForms model
 124     void setModel(
 125         const com::sun::star::uno::Reference<com::sun::star::xforms::XModel>& );
 126
 127     rtl::OUString getID() const;         /// get ID for this submission
 128     void setID( const rtl::OUString& );  /// set ID for this submission
 129
 130     rtl::OUString getBind() const;
 131     void setBind( const rtl::OUString& );
 132
 133     rtl::OUString getRef() const;
 134     void setRef( const rtl::OUString& );
 135
 136     rtl::OUString getAction() const;
 137     void setAction( const rtl::OUString& );
 138
 139     rtl::OUString getMethod() const;
 140     void setMethod( const rtl::OUString& );
 141
 142     rtl::OUString getVersion() const;
 143     void setVersion( const rtl::OUString& );
 144
 145     bool getIndent() const;
 146     void setIndent( bool );
 147
 148     rtl::OUString getMediaType() const;
 149     void setMediaType( const rtl::OUString& );
 150
 151     rtl::OUString getEncoding() const;
 152     void setEncoding( const rtl::OUString& );
 153
 154     bool getOmitXmlDeclaration() const;
 155     void setOmitXmlDeclaration( bool );
 156
 157     bool getStandalone() const;
 158     void setStandalone( bool );
 159
 160     rtl::OUString getCDataSectionElement() const;
 161     void setCDataSectionElement( const rtl::OUString& );
 162
 163     rtl::OUString getReplace() const;
 164     void setReplace( const rtl::OUString& );
 165
 166     rtl::OUString getSeparator() const;
 167     void setSeparator( const rtl::OUString& );
 168
 169     com::sun::star::uno::Sequence< rtl::OUString > getIncludeNamespacePrefixes() const;
 170     void setIncludeNamespacePrefixes( const com::sun::star::uno::Sequence< rtl::OUString >& );
 171
 172
 173     /** perform the submission
 174      * @returns if submission was successful */
 175     bool doSubmit( const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionHandler >& aHandler );
 176
 177
 178     /// release the model (note: Binding is unusable without model)
 179     void releaseModel();
 180
 181
 182     // helpers for UNO tunnel
 183     static com::sun::star::uno::Sequence<sal_Int8> getUnoTunnelID();
 184     static Submission* getSubmission( const com::sun::star::uno::Reference<com::sun::star::beans::XPropertySet>& );
 185
 186
 187
 188 private:
 189
 190     /// check whether object is live, and throw suitable exception if not
 191     /// (to be used be API methods before acting on the object)
 192     void liveCheck()
 193         throw( com::sun::star::uno::RuntimeException );
 194
 195     /// get the model implementation
 196     xforms::Model* getModelImpl() const;
 197     xforms::Model* getModelImpl( const com::sun::star::uno::Reference<com::sun::star::xforms::XModel>& xModel ) const;
 198
 199
 200
 201 protected:
 202
 203     //
 204     // XPropertySet & friends:
 205     //   implement abstract methods from PropertySetHelper
 206     //
 207
 208     virtual sal_Bool SAL_CALL convertFastPropertyValue(
 209         com::sun::star::uno::Any& rConvertedValue,
 210         com::sun::star::uno::Any& rOldValue,
 211         sal_Int32 nHandle,
 212         const com::sun::star::uno::Any& rValue )
 213         throw ( com::sun::star::lang::IllegalArgumentException );
 214
 215 private:
 216     void initializePropertySet();
 217
 218
 219 public:
 220
 221     //
 222     // XNamed:
 223     //   get/set name
 224     //
 225
 226     virtual rtl::OUString SAL_CALL getName()
 227         throw( com::sun::star::uno::RuntimeException );
 228
 229     virtual void SAL_CALL setName( const rtl::OUString& )
 230         throw( com::sun::star::uno::RuntimeException );
 231
 232
 233
 234     //
 235     // XUnoTunnel
 236     //
 237
 238     virtual sal_Int64 SAL_CALL getSomething(
 239         const com::sun::star::uno::Sequence<sal_Int8>& )
 240         throw( com::sun::star::uno::RuntimeException );
 241
 242
 243     //
 244     // XSubmission
 245     //
 246
 247     virtual void SAL_CALL submit(  )
 248         throw ( com::sun::star::util::VetoException,
 249                 com::sun::star::lang::WrappedTargetException,
 250                 com::sun::star::uno::RuntimeException );
 251     virtual void SAL_CALL submitWithInteraction(
 252         const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionHandler >& aHandler )
 253         throw ( com::sun::star::util::VetoException,
 254                 com::sun::star::lang::WrappedTargetException,
 255                 com::sun::star::uno::RuntimeException );
 256     virtual void SAL_CALL addSubmissionVetoListener(
 257         const ::com::sun::star::uno::Reference< ::com::sun::star::form::submission::XSubmissionVetoListener >& listener )
 258         throw (::com::sun::star::lang::NoSupportException, ::com::sun::star::uno::RuntimeException);
 259     virtual void SAL_CALL removeSubmissionVetoListener(
 260         const ::com::sun::star::uno::Reference< ::com::sun::star::form::submission::XSubmissionVetoListener >& listener )
 261         throw (::com::sun::star::lang::NoSupportException, ::com::sun::star::uno::RuntimeException);
 262
 263     //
 264     // XPropertySet
 265     // (need to disambiguate this)
 266
 267     virtual ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo(  ) throw(::com::sun::star::uno::RuntimeException);
 268     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);
 269     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);
 270     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);
 271     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);
 272     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);
 273     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);
 274 };
 275
 276
 277 } // namespace xforms
 278
 279 #endif