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 :: form :: submission ::

unpublished interface XSubmission
Usage Restrictions
not published
Description
is implemented by components which support submitting data.

Methods' Summary
submit tells the component to submit data  
submitWithInteraction tells the component to submit data  
addSubmissionVetoListener registers the given listener to be notified when a submission occurs  
removeSubmissionVetoListener revokes a listener which has previously been registered to be notified when a submission occurs  
Methods' Details
submit
void
submit()
raises( ::com::sun::star::util::VetoException,
::com::sun::star::lang::WrappedTargetException );

Description
tells the component to submit data
Throws
com::sun::star::util::VetoException if the submission has been vetoed. Usually, this indicates that not all requirements for the submission, e.g. data consistency, are fulfilled.
Throws
com::sun::star::lang::WrappedTargetException if an error occured during invoking the submission target
submitWithInteraction
void
submitWithInteraction( [in] ::com::sun::star::task::XInteractionHandler  aHandler )
raises( ::com::sun::star::util::VetoException,
::com::sun::star::lang::WrappedTargetException );

Description
tells the component to submit data
Parameter aHandler
This handler allows additional user interaction, which may be necessary before the submission can be performed.
Throws
com::sun::star::util::VetoException if the submission has been vetoed. Usually, this indicates that not all requirements for the submission, e.g. data consistency, are fulfilled.
Throws
com::sun::star::lang::WrappedTargetException if an error occured during invoking the submission target
addSubmissionVetoListener
void
addSubmissionVetoListener( [in] XSubmissionVetoListener  listener )
raises( ::com::sun::star::lang::NoSupportException );

Description
registers the given listener to be notified when a submission occurs
Parameter listener
the listener to register
Throws
com::sun::star::lang::NoSupportException when the component does not support external componentsw vetoing the submission
removeSubmissionVetoListener
void
removeSubmissionVetoListener( [in] XSubmissionVetoListener  listener )
raises( ::com::sun::star::lang::NoSupportException );

Description
revokes a listener which has previously been registered to be notified when a submission occurs
Parameter listener
the listener to revoke
Throws
com::sun::star::lang::NoSupportException when the component does not support external componentsw vetoing the submission
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.