xforms::Submission Class Reference

#include <submission.hxx>

Inheritance diagram for xforms::Submission:

Collaboration diagram for xforms::Submission:

Public Member Functions
	Submission ()
virtual	~Submission () noexcept override
css::uno::Reference< css::xforms::XModel >	getModel () const
	get XForms model More...
xforms::Model *	getModelImpl () const
	get the model implementation More...
void	setModel (const css::uno::Reference< css::xforms::XModel > &)
	set XForms model More...
OUString	getID () const
void	setID (const OUString &)
	get ID for this submission More...
OUString	getBind () const
	set ID for this submission More...
void	setBind (const OUString &)
OUString	getRef () const
void	setRef (const OUString &)
OUString	getAction () const
void	setAction (const OUString &)
OUString	getMethod () const
void	setMethod (const OUString &)
OUString	getVersion () const
void	setVersion (const OUString &)
bool	getIndent () const
void	setIndent (bool)
OUString	getMediaType () const
void	setMediaType (const OUString &)
OUString	getEncoding () const
void	setEncoding (const OUString &)
bool	getOmitXmlDeclaration () const
void	setOmitXmlDeclaration (bool)
bool	getStandalone () const
void	setStandalone (bool)
OUString	getCDataSectionElement () const
void	setCDataSectionElement (const OUString &)
OUString	getReplace () const
void	setReplace (const OUString &)
OUString	getSeparator () const
void	setSeparator (const OUString &)
css::uno::Sequence< OUString >	getIncludeNamespacePrefixes () const
void	setIncludeNamespacePrefixes (const css::uno::Sequence< OUString > &)
bool	doSubmit (const css::uno::Reference< css::task::XInteractionHandler > &aHandler)
	perform the submission More...
virtual OUString SAL_CALL	getName () override
virtual void SAL_CALL	setName (const OUString &) override
virtual void SAL_CALL	submit () override
virtual void SAL_CALL	submitWithInteraction (const css::uno::Reference< css::task::XInteractionHandler > &aHandler) override
virtual void SAL_CALL	addSubmissionVetoListener (const css::uno::Reference< css::form::submission::XSubmissionVetoListener > &listener) override
virtual void SAL_CALL	removeSubmissionVetoListener (const css::uno::Reference< css::form::submission::XSubmissionVetoListener > &listener) override
virtual css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL	getPropertySetInfo () override
virtual void SAL_CALL	setPropertyValue (const OUString &aPropertyName, const css::uno::Any &aValue) override
virtual css::uno::Any SAL_CALL	getPropertyValue (const OUString &PropertyName) override
virtual void SAL_CALL	addPropertyChangeListener (const OUString &aPropertyName, const css::uno::Reference< css::beans::XPropertyChangeListener > &xListener) override
virtual void SAL_CALL	removePropertyChangeListener (const OUString &aPropertyName, const css::uno::Reference< css::beans::XPropertyChangeListener > &aListener) override
virtual void SAL_CALL	addVetoableChangeListener (const OUString &PropertyName, const css::uno::Reference< css::beans::XVetoableChangeListener > &aListener) override
virtual void SAL_CALL	removeVetoableChangeListener (const OUString &PropertyName, const css::uno::Reference< css::beans::XVetoableChangeListener > &aListener) override

Protected Member Functions
virtual sal_Bool SAL_CALL	convertFastPropertyValue (css::uno::Any &rConvertedValue, css::uno::Any &rOldValue, sal_Int32 nHandle, const css::uno::Any &rValue) override

Private Member Functions
css::uno::Reference< css::xml::dom::XDocumentFragment >	createSubmissionDocument (const css::uno::Reference< css::xml::xpath::XXPathObject > &aObject, bool bRemoveWSNodes)
void	liveCheck ()
	check whether object is live, and throw suitable exception if not (to be used be API methods before acting on the object) More...
void	initializePropertySet ()

Static Private Member Functions
static css::uno::Reference< css::xml::dom::XDocument >	getInstanceDocument (const css::uno::Reference< css::xml::xpath::XXPathObject > &aObject)

Private Attributes
OUString	msID
OUString	msBind
ComputedExpression	maRef
OUString	msAction
OUString	msMethod
OUString	msVersion
bool	mbIndent
OUString	msMediaType
OUString	msEncoding
bool	mbOmitXmlDeclaration
bool	mbStandalone
OUString	msCDataSectionElement
OUString	msReplace
OUString	msSeparator
css::uno::Sequence< OUString >	msIncludeNamespacePrefixes
rtl::Reference< Model >	mxModel
	the Model to which this Submission belongs; may be NULL More...

Detailed Description

Definition at line 57 of file submission.hxx.

Constructor & Destructor Documentation

Submission()

Submission::Submission

(

)

Definition at line 75 of file submission.cxx.

References initializePropertySet().

~Submission()

Submission::~Submission ( )

overridevirtualnoexcept

Definition at line 84 of file submission.cxx.

Member Function Documentation

addPropertyChangeListener()

void SAL_CALL Submission::addPropertyChangeListener ( const OUString &  aPropertyName, const css::uno::Reference< css::beans::XPropertyChangeListener > &  xListener  )

overridevirtual

Definition at line 599 of file submission.cxx.

addSubmissionVetoListener()

void SAL_CALL Submission::addSubmissionVetoListener ( const css::uno::Reference< css::form::submission::XSubmissionVetoListener > &  listener )

overridevirtual

Definition at line 499 of file submission.cxx.

addVetoableChangeListener()

void SAL_CALL Submission::addVetoableChangeListener ( const OUString &  PropertyName, const css::uno::Reference< css::beans::XVetoableChangeListener > &  aListener  )

overridevirtual

Definition at line 607 of file submission.cxx.

convertFastPropertyValue()

sal_Bool SAL_CALL Submission::convertFastPropertyValue ( css::uno::Any &  rConvertedValue, css::uno::Any &  rOldValue, sal_Int32  nHandle, const css::uno::Any &  rValue  )

overrideprotectedvirtual

Definition at line 372 of file submission.cxx.

References Any, PropertySetBase::convertFastPropertyValue(), HANDLE_IncludeNamespacePrefixes, nHandle, and p.

createSubmissionDocument()

Reference< XDocumentFragment > Submission::createSubmissionDocument ( const css::uno::Reference< css::xml::xpath::XXPathObject > &  aObject, bool  bRemoveWSNodes  )

private

Definition at line 561 of file submission.cxx.

References aDocument, cloneNodes(), getModelImpl(), comphelper::getProcessComponentContext(), and i.

Referenced by doSubmit().

doSubmit()

bool Submission::doSubmit

(

const css::uno::Reference< css::task::XInteractionHandler > &

aHandler

)

perform the submission

Returns

if submission was successful

Definition at line 189 of file submission.cxx.

References Application::CreateMessageDialog(), createSubmissionDocument(), xforms::ComputedExpression::evaluate(), getAction(), xforms::Binding::getBindingExpression(), xforms::Binding::getEvaluationContext(), xforms::ComputedExpression::getExpression(), Application::GetFrameWeld(), INetURLObject::getFSysPath(), getInstanceDocument(), getMethod(), INetURLObject::GetProtocol(), getReplace(), xforms::ComputedExpression::getXPath(), liveCheck(), frm::ResourceManager::loadString(), maRef, msBind, mxModel, RET_NO, RET_YES, xforms::ComputedExpression::setExpression(), and CSubmission::SUCCESS.

Referenced by submitWithInteraction().

getAction()

OUString xforms::Submission::getAction ( ) const

inline

Definition at line 115 of file submission.hxx.

References msAction.

Referenced by doSubmit(), and initializePropertySet().

getBind()

OUString xforms::Submission::getBind ( ) const

inline

set ID for this submission

Definition at line 109 of file submission.hxx.

References msBind.

Referenced by initializePropertySet().

getCDataSectionElement()

OUString xforms::Submission::getCDataSectionElement ( ) const

inline

Definition at line 139 of file submission.hxx.

References msCDataSectionElement.

Referenced by initializePropertySet().

getEncoding()

OUString xforms::Submission::getEncoding ( ) const

inline

Definition at line 130 of file submission.hxx.

References msEncoding.

Referenced by initializePropertySet().

getID()

OUString xforms::Submission::getID ( ) const

inline

Definition at line 106 of file submission.hxx.

References msID.

Referenced by getName(), and initializePropertySet().

getIncludeNamespacePrefixes()

css::uno::Sequence< OUString > xforms::Submission::getIncludeNamespacePrefixes ( ) const

inline

Definition at line 148 of file submission.hxx.

References msIncludeNamespacePrefixes.

Referenced by initializePropertySet().

getIndent()

bool xforms::Submission::getIndent ( ) const

inline

Definition at line 124 of file submission.hxx.

References mbIndent.

Referenced by initializePropertySet().

getInstanceDocument()

Reference< XDocument > Submission::getInstanceDocument ( const css::uno::Reference< css::xml::xpath::XXPathObject > &  aObject )

staticprivate

Definition at line 546 of file submission.cxx.

References aDocument.

Referenced by doSubmit().

getMediaType()

OUString xforms::Submission::getMediaType ( ) const

inline

Definition at line 127 of file submission.hxx.

References msMediaType.

Referenced by initializePropertySet().

getMethod()

OUString xforms::Submission::getMethod ( ) const

inline

Definition at line 118 of file submission.hxx.

References msMethod.

Referenced by doSubmit(), and initializePropertySet().

getModel()

css::uno::Reference< XModel > Submission::getModel

(

)

const

get XForms model

Definition at line 291 of file submission.cxx.

References mxModel.

Referenced by initializePropertySet().

getModelImpl()

xforms::Model * xforms::Submission::getModelImpl ( ) const

inline

get the model implementation

Definition at line 100 of file submission.hxx.

References mxModel.

Referenced by createSubmissionDocument(), and xforms::Model::submitWithInteraction().

getName()

OUString SAL_CALL Submission::getName ( )

overridevirtual

Definition at line 395 of file submission.cxx.

References getID().

getOmitXmlDeclaration()

bool xforms::Submission::getOmitXmlDeclaration ( ) const

inline

Definition at line 133 of file submission.hxx.

References mbOmitXmlDeclaration.

Referenced by initializePropertySet().

getPropertySetInfo()

Reference< css::beans::XPropertySetInfo > SAL_CALL Submission::getPropertySetInfo ( )

overridevirtual

Definition at line 587 of file submission.cxx.

References PropertySetBase::getPropertySetInfo().

getPropertyValue()

Any SAL_CALL Submission::getPropertyValue ( const OUString &  PropertyName )

overridevirtual

Definition at line 595 of file submission.cxx.

References Any.

getRef()

OUString Submission::getRef

(

)

const

Definition at line 107 of file submission.cxx.

References xforms::ComputedExpression::getExpression(), and maRef.

Referenced by initializePropertySet().

getReplace()

OUString xforms::Submission::getReplace ( ) const

inline

Definition at line 142 of file submission.hxx.

References msReplace.

Referenced by doSubmit(), and initializePropertySet().

getSeparator()

OUString xforms::Submission::getSeparator ( ) const

inline

Definition at line 145 of file submission.hxx.

References msSeparator.

Referenced by initializePropertySet().

getStandalone()

bool xforms::Submission::getStandalone ( ) const

inline

Definition at line 136 of file submission.hxx.

References mbStandalone.

Referenced by initializePropertySet().

getVersion()

OUString xforms::Submission::getVersion ( ) const

inline

Definition at line 121 of file submission.hxx.

References msVersion.

Referenced by initializePropertySet().

initializePropertySet()

void Submission::initializePropertySet ( )

private

Definition at line 317 of file submission.cxx.

References getAction(), getBind(), getCDataSectionElement(), getEncoding(), getID(), getIncludeNamespacePrefixes(), getIndent(), getMediaType(), getMethod(), getModel(), getOmitXmlDeclaration(), getRef(), getReplace(), getSeparator(), getStandalone(), getVersion(), HANDLE_Action, HANDLE_Bind, HANDLE_CDataSectionElement, HANDLE_Encoding, HANDLE_ID, HANDLE_IncludeNamespacePrefixes, HANDLE_Indent, HANDLE_MediaType, HANDLE_Method, HANDLE_Model, HANDLE_OmitXmlDeclaration, HANDLE_Ref, HANDLE_Replace, HANDLE_Separator, HANDLE_Standalone, HANDLE_Version, setAction(), setBind(), setCDataSectionElement(), setEncoding(), setID(), setIncludeNamespacePrefixes(), setIndent(), setMediaType(), setMethod(), setModel(), setOmitXmlDeclaration(), setRef(), setReplace(), setSeparator(), setStandalone(), and setVersion().

Referenced by Submission().

liveCheck()

void Submission::liveCheck ( )

private

check whether object is live, and throw suitable exception if not (to be used be API methods before acting on the object)

Exceptions

css::uno::RuntimeException

Definition at line 283 of file submission.cxx.

References mxModel.

Referenced by doSubmit().

removePropertyChangeListener()

void SAL_CALL Submission::removePropertyChangeListener ( const OUString &  aPropertyName, const css::uno::Reference< css::beans::XPropertyChangeListener > &  aListener  )

overridevirtual

Definition at line 603 of file submission.cxx.

removeSubmissionVetoListener()

void SAL_CALL Submission::removeSubmissionVetoListener ( const css::uno::Reference< css::form::submission::XSubmissionVetoListener > &  listener )

overridevirtual

Definition at line 505 of file submission.cxx.

removeVetoableChangeListener()

void SAL_CALL Submission::removeVetoableChangeListener ( const OUString &  PropertyName, const css::uno::Reference< css::beans::XVetoableChangeListener > &  aListener  )

overridevirtual

Definition at line 611 of file submission.cxx.

setAction()

void Submission::setAction

(

const OUString &

sAction

)

Definition at line 118 of file submission.cxx.

References msAction.

Referenced by initializePropertySet().

setBind()

void Submission::setBind

(

const OUString &

sBind

)

Definition at line 102 of file submission.cxx.

References msBind.

Referenced by initializePropertySet().

setCDataSectionElement()

void Submission::setCDataSectionElement

(

const OUString &

sCDataSectionElement

)

Definition at line 166 of file submission.cxx.

References msCDataSectionElement.

Referenced by initializePropertySet().

setEncoding()

void Submission::setEncoding

(

const OUString &

sEncoding

)

Definition at line 148 of file submission.cxx.

References msEncoding.

Referenced by initializePropertySet().

setID()

void Submission::setID

(

const OUString &

sID

)

get ID for this submission

Definition at line 96 of file submission.cxx.

References msID.

Referenced by initializePropertySet(), and setName().

setIncludeNamespacePrefixes()

void Submission::setIncludeNamespacePrefixes

(

const css::uno::Sequence< OUString > &

)

Definition at line 184 of file submission.cxx.

References msIncludeNamespacePrefixes.

Referenced by initializePropertySet().

setIndent()

void Submission::setIndent

(

bool

bIndent

)

Definition at line 136 of file submission.cxx.

References mbIndent.

Referenced by initializePropertySet().

setMediaType()

void Submission::setMediaType

(

const OUString &

sMediaType

)

Definition at line 142 of file submission.cxx.

References msMediaType, and sMediaType.

Referenced by initializePropertySet().

setMethod()

void Submission::setMethod

(

const OUString &

sMethod

)

Definition at line 124 of file submission.cxx.

References msMethod.

Referenced by initializePropertySet().

setModel()

void Submission::setModel

(

const css::uno::Reference< css::xforms::XModel > &

)

set XForms model

Definition at line 89 of file submission.cxx.

References mxModel, and xModel.

Referenced by initializePropertySet().

setName()

void SAL_CALL Submission::setName ( const OUString &  sID )

overridevirtual

Definition at line 400 of file submission.cxx.

References setID().

setOmitXmlDeclaration()

void Submission::setOmitXmlDeclaration

(

bool

bOmitXmlDeclaration

)

Definition at line 154 of file submission.cxx.

References mbOmitXmlDeclaration.

Referenced by initializePropertySet().

setPropertyValue()

void SAL_CALL Submission::setPropertyValue ( const OUString &  aPropertyName, const css::uno::Any &  aValue  )

overridevirtual

Definition at line 591 of file submission.cxx.

setRef()

void Submission::setRef

(

const OUString &

sRef

)

Definition at line 112 of file submission.cxx.

References maRef, and xforms::ComputedExpression::setExpression().

Referenced by initializePropertySet().

setReplace()

void Submission::setReplace

(

const OUString &

sReplace

)

Definition at line 172 of file submission.cxx.

References msReplace.

Referenced by initializePropertySet().

setSeparator()

void Submission::setSeparator

(

const OUString &

sSeparator

)

Definition at line 178 of file submission.cxx.

References msSeparator.

Referenced by initializePropertySet().

setStandalone()

void Submission::setStandalone

(

bool

bStandalone

)

Definition at line 160 of file submission.cxx.

References mbStandalone.

Referenced by initializePropertySet().

setVersion()

void Submission::setVersion

(

const OUString &

sVersion

)

Definition at line 130 of file submission.cxx.

References msVersion.

Referenced by initializePropertySet().

submit()

void SAL_CALL Submission::submit ( )

overridevirtual

Definition at line 494 of file submission.cxx.

References submitWithInteraction().

submitWithInteraction()

void SAL_CALL Submission::submitWithInteraction ( const css::uno::Reference< css::task::XInteractionHandler > &  aHandler )

overridevirtual

Definition at line 412 of file submission.cxx.

References Any, doSubmit(), Exception, cppu::getCaughtException(), lcl_message(), msID, mxModel, u, and xModel.

Referenced by submit(), and xforms::Model::submitWithInteraction().

Member Data Documentation

maRef

ComputedExpression xforms::Submission::maRef

private

Definition at line 62 of file submission.hxx.

Referenced by doSubmit(), getRef(), and setRef().

mbIndent

bool xforms::Submission::mbIndent

private

Definition at line 66 of file submission.hxx.

Referenced by getIndent(), and setIndent().

mbOmitXmlDeclaration

bool xforms::Submission::mbOmitXmlDeclaration

private

Definition at line 69 of file submission.hxx.

Referenced by getOmitXmlDeclaration(), and setOmitXmlDeclaration().

mbStandalone

bool xforms::Submission::mbStandalone

private

Definition at line 70 of file submission.hxx.

Referenced by getStandalone(), and setStandalone().

msAction

OUString xforms::Submission::msAction

private

Definition at line 63 of file submission.hxx.

Referenced by getAction(), and setAction().

msBind

OUString xforms::Submission::msBind

private

Definition at line 61 of file submission.hxx.

Referenced by doSubmit(), getBind(), and setBind().

msCDataSectionElement

OUString xforms::Submission::msCDataSectionElement

private

Definition at line 71 of file submission.hxx.

Referenced by getCDataSectionElement(), and setCDataSectionElement().

msEncoding

OUString xforms::Submission::msEncoding

private

Definition at line 68 of file submission.hxx.

Referenced by getEncoding(), and setEncoding().

msID

OUString xforms::Submission::msID

private

Definition at line 60 of file submission.hxx.

Referenced by getID(), setID(), and submitWithInteraction().

msIncludeNamespacePrefixes

css::uno::Sequence< OUString > xforms::Submission::msIncludeNamespacePrefixes

private

Definition at line 74 of file submission.hxx.

Referenced by getIncludeNamespacePrefixes(), and setIncludeNamespacePrefixes().

msMediaType

OUString xforms::Submission::msMediaType

private

Definition at line 67 of file submission.hxx.

Referenced by getMediaType(), and setMediaType().

msMethod

OUString xforms::Submission::msMethod

private

Definition at line 64 of file submission.hxx.

Referenced by getMethod(), and setMethod().

msReplace

OUString xforms::Submission::msReplace

private

Definition at line 72 of file submission.hxx.

Referenced by getReplace(), and setReplace().

msSeparator

OUString xforms::Submission::msSeparator

private

Definition at line 73 of file submission.hxx.

Referenced by getSeparator(), and setSeparator().

msVersion

OUString xforms::Submission::msVersion

private

Definition at line 65 of file submission.hxx.

Referenced by getVersion(), and setVersion().

mxModel

rtl::Reference<Model> xforms::Submission::mxModel

private

the Model to which this Submission belongs; may be NULL

Definition at line 79 of file submission.hxx.

Referenced by doSubmit(), getModel(), getModelImpl(), liveCheck(), setModel(), and submitWithInteraction().

---

The documentation for this class was generated from the following files:

• submission.hxx
• submission.cxx