Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: xforms ::

unpublished interface XModel
Usage Restrictions
not published
Description
represent an XForms model

Methods' Summary
getID get the XForms model ID  
setID set the XForms model ID  
initialize initialize the model  
rebuild rebuild the model  
recalculate re-evaluate all calculate attributes  
revalidate re-evaluate all validity attributes  
refresh refresh the model  
submit submit form through given submission id  
submitWithInteraction submit form through given submission id  
getDataTypeRepository provides management access to the XSD data types associated with the model  
getInstances gets container containing all instances;  
getInstanceDocument retrieves the instance with the given id  
getDefaultInstance get the default instance for this model  
createBinding create a binding element for this model  
cloneBinding clone an arbitrary binding element for this model; still needs  
getBinding get a binding with a certain ID  
getBindings get a container containing all bindings; also supports XNameAccess  
createSubmission create a submission element for this model  
cloneSubmission clone an arbitrary submission element for this model  
getSubmission get a submission with a certain ID.  
getSubmissions get container containing all submissions; also supports XNameAccess  
Methods' Details
getID
string
getID();

Description
get the XForms model ID
setID
void
setID( [in] string  id );

Description
set the XForms model ID
initialize
void
initialize();

Description
initialize the model
rebuild
void
rebuild();

Description
rebuild the model
recalculate
void
recalculate();

Description
re-evaluate all calculate attributes
revalidate
void
revalidate();

Description
re-evaluate all validity attributes
refresh
void
refresh();

Description
refresh the model
submit
void
submit( [in] string  id )
raises( ::com::sun::star::util::VetoException,
::com::sun::star::lang::WrappedTargetException );

Description
submit form through given submission id

This is a convenience method. Calling it is equivalent to calling getSubmission( id ).submit().

Parameter id
the ID of the submission to execute
Throws
com::sun::star::util::VetoException when the current model state does not allow a submission. Usually, this indicates that consistency criteria for the model data is not fulfilled.
Throws
com::sun::star::lang::WrappedTargetException when another error occured during the submission. The ::com::sun::star::lang::WrappedTargetException::TargetException describes this error then.
submitWithInteraction
void
submitWithInteraction( [in] string  id,
[in] ::com::sun::star::task::XInteractionHandler  aHandler )
raises( ::com::sun::star::util::VetoException,
::com::sun::star::lang::WrappedTargetException );

Description
submit form through given submission id

This is a convenience method. Calling it is equivalent to calling getSubmission( id, handler ).submit().

Parameter id
the ID of the submission to execute
Parameter aHandler
This handler allows additional user interaction, which may be necessary before the submission can be performed.
Throws
com::sun::star::util::VetoException when the current model state does not allow a submission. Usually, this indicates that consistency criteria for the model data is not fulfilled.
Throws
com::sun::star::lang::WrappedTargetException when another error occured during the submission. The ::com::sun::star::lang::WrappedTargetException::TargetException describes this error then.
getDataTypeRepository
XDataTypeRepository
getDataTypeRepository();

Description
provides management access to the XSD data types associated with the model
getInstances
::com::sun::star::container::XSet
getInstances();

Description
gets container containing all instances;

The elements of the set are arrays of ::com::sun::star::beans::PropertyValues, containing the ID, the URL, and the instance itself.

getInstanceDocument
::com::sun::star::xml::dom::XDocument
getInstanceDocument( [in] string  id );

Description
retrieves the instance with the given id
getDefaultInstance
::com::sun::star::xml::dom::XDocument
getDefaultInstance();

Description
get the default instance for this model
createBinding
::com::sun::star::beans::XPropertySet
createBinding();

Description
create a binding element for this model

The returned binding still needs to be inserted into the bindings container.

See also
getBindings
cloneBinding
::com::sun::star::beans::XPropertySet
cloneBinding( [in] ::com::sun::star::beans::XPropertySet  binding );

Description
clone an arbitrary binding element for this model; still needs

The returned binding still needs to be inserted into the bindings container.

See also
getBindings
getBinding
::com::sun::star::beans::XPropertySet
getBinding( [in] string  id );

Description
get a binding with a certain ID

This is a convenience method: the same result can also be obtained through getBindings

getBindings
::com::sun::star::container::XSet
getBindings();

Description
get a container containing all bindings; also supports XNameAccess
createSubmission
XSubmission
createSubmission();

Description
create a submission element for this model

The returned submission element still needs to be inserted into the submission container.

See also
getSubmissions
cloneSubmission
XSubmission
cloneSubmission( [in] ::com::sun::star::beans::XPropertySet  submission );

Description
clone an arbitrary submission element for this model

The returned submission element still needs to be inserted into the submission container.

See also
getSubmissions
getSubmission
XSubmission
getSubmission( [in] string  id );

Description
get a submission with a certain ID.

This is a convenience method: the same result can also be obtained through getSubmissions.

getSubmissions
::com::sun::star::container::XSet
getSubmissions();

Description
get container containing all submissions; also supports XNameAccess
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.