LibreOffice
LibreOffice 24.2 SDK API Reference
Loading...
Searching...
No Matches
XModel Interface Reference

represent an XForms model More...

import <XModel.idl;

Inheritance diagram for XModel:
XModel2 Model

Public Member Functions

string getID ()
 get the XForms model ID
 
void setID ([in] string id)
 set the XForms model ID
 
void initialize ()
 initialize the model
 
void rebuild ()
 rebuild the model
 
void recalculate ()
 re-evaluate all calculate attributes
 
void revalidate ()
 re-evaluate all validity attributes
 
void refresh ()
 refresh the model
 
void submit ([in] string id) raises ( com::sun::star::util::VetoException, com::sun::star::lang::WrappedTargetException )
 submit form through given submission id
 
void submitWithInteraction ([in] string id, [in] com::sun::star::task::XInteractionHandler aHandler) raises ( com::sun::star::util::VetoException, com::sun::star::lang::WrappedTargetException )
 submit form through given submission id
 
XDataTypeRepository getDataTypeRepository ()
 provides management access to the XSD data types associated with the model
 
com::sun::star::container::XSet getInstances ()
 gets container containing all instances;
 
com::sun::star::xml::dom::XDocument getInstanceDocument ([in] string id)
 retrieves the instance with the given id
 
com::sun::star::xml::dom::XDocument getDefaultInstance ()
 get the default instance for this model
 
com::sun::star::beans::XPropertySet createBinding ()
 create a binding element for this model
 
com::sun::star::beans::XPropertySet cloneBinding ([in] com::sun::star::beans::XPropertySet binding)
 clone an arbitrary binding element for this model; still needs
 
com::sun::star::beans::XPropertySet getBinding ([in] string id)
 get a binding with a certain ID
 
com::sun::star::container::XSet getBindings ()
 get a container containing all bindings; also supports XNameAccess
 
XSubmission createSubmission ()
 create a submission element for this model
 
XSubmission cloneSubmission ([in] com::sun::star::beans::XPropertySet submission)
 clone an arbitrary submission element for this model
 
XSubmission getSubmission ([in] string id)
 get a submission with a certain ID.
 
com::sun::star::container::XSet getSubmissions ()
 get container containing all submissions; also supports XNameAccess
 

Detailed Description

represent an XForms model

Member Function Documentation

◆ cloneBinding()

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

◆ cloneSubmission()

XSubmission cloneSubmission ( [in] com::sun::star::beans::XPropertySet submission)

clone an arbitrary submission element for this model

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

See also
getSubmissions

◆ createBinding()

create a binding element for this model

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

See also
getBindings

◆ createSubmission()

XSubmission createSubmission ( )

create a submission element for this model

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

See also
getSubmissions

◆ getBinding()

com::sun::star::beans::XPropertySet getBinding ( [in] string id)

get a binding with a certain ID

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

◆ getBindings()

get a container containing all bindings; also supports XNameAccess

◆ getDataTypeRepository()

XDataTypeRepository getDataTypeRepository ( )

provides management access to the XSD data types associated with the model

◆ getDefaultInstance()

com::sun::star::xml::dom::XDocument getDefaultInstance ( )

get the default instance for this model

◆ getID()

string getID ( )

get the XForms model ID

◆ getInstanceDocument()

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

retrieves the instance with the given id

◆ getInstances()

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.

◆ getSubmission()

XSubmission getSubmission ( [in] string id)

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 ( )

get container containing all submissions; also supports XNameAccess

◆ initialize()

void initialize ( )

initialize the model

◆ rebuild()

void rebuild ( )

rebuild the model

◆ recalculate()

void recalculate ( )

re-evaluate all calculate attributes

◆ refresh()

void refresh ( )

refresh the model

◆ revalidate()

void revalidate ( )

re-evaluate all validity attributes

◆ setID()

void setID ( [in] string id)

set the XForms model ID

◆ submit()

submit form through given submission id

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

Parameters
idthe ID of the submission to execute
Exceptions
com::sun::star::util::VetoExceptionwhen the current model state does not allow a submission. Usually, this indicates that consistency criteria for the model data is not fulfilled.
com::sun::star::lang::WrappedTargetExceptionwhen another error occurred during the submission. The com::sun::star::lang::WrappedTargetException::TargetException describes this error then.

◆ submitWithInteraction()

submit form through given submission id

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

Parameters
idthe ID of the submission to execute
aHandlerThis handler allows additional user interaction, which may be necessary before the submission can be performed.
Exceptions
com::sun::star::util::VetoExceptionwhen the current model state does not allow a submission. Usually, this indicates that consistency criteria for the model data is not fulfilled.
com::sun::star::lang::WrappedTargetExceptionwhen another error occurred during the submission. The com::sun::star::lang::WrappedTargetException::TargetException describes this error then.

The documentation for this interface was generated from the following file: