diff options
author | Oliver Bolte <obo@openoffice.org> | 2004-11-16 10:11:18 +0000 |
---|---|---|
committer | Oliver Bolte <obo@openoffice.org> | 2004-11-16 10:11:18 +0000 |
commit | bba4b6ea4f8350bd768b0a7e6a55ee64a0c02ac1 (patch) | |
tree | 37e2c70dbbfe8126598cf339027ebed17f9a3e29 /offapi/com/sun/star/xforms | |
parent | 52d3882328742c30d7e09324a8bf3bcb17fe41ff (diff) |
INTEGRATION: CWS eforms2 (1.1.2); FILE ADDED
2004/11/05 17:48:00 fs 1.1.2.11: #i36765# allow submission with InteractionHandler
2004/11/04 12:04:21 fs 1.1.2.10: documentation
2004/08/24 13:39:52 fs 1.1.2.9: remove redundant include
2004/07/12 13:52:54 fs 1.1.2.8: #114856# introduced and used XSubmission
2004/05/26 15:07:44 dvo 1.1.2.7: #114856# xforms::XModel: bindings + submissions as container::XSet
Issue number:
Submitted by:
Reviewed by:
2004/05/13 10:37:51 lo 1.1.2.6: #i28981# get instance by id for xforms xpath function library
2004/04/27 14:06:29 fs 1.1.2.5: comment corrected
2004/04/26 12:22:12 fs 1.1.2.4: +getDataTypeRepository
2004/04/07 13:31:01 dvo 1.1.2.3: #114856# access submission/binding
2004/04/01 11:02:50 dvo 1.1.2.2: #114856# add submission handling to xforms::XModel
2004/03/23 14:20:38 dvo 1.1.2.1: #114856# add XForms API
Diffstat (limited to 'offapi/com/sun/star/xforms')
-rw-r--r-- | offapi/com/sun/star/xforms/XModel.idl | 272 |
1 files changed, 272 insertions, 0 deletions
diff --git a/offapi/com/sun/star/xforms/XModel.idl b/offapi/com/sun/star/xforms/XModel.idl new file mode 100644 index 000000000..94d4efa23 --- /dev/null +++ b/offapi/com/sun/star/xforms/XModel.idl @@ -0,0 +1,272 @@ +/************************************************************************* + * + * $RCSfile: XModel.idl,v $ + * + * $Revision: 1.2 $ + * + * last change: $Author: obo $ $Date: 2004-11-16 11:11:18 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#ifndef __com_sun_star_xforms_XModel_idl__ +#define __com_sun_star_xforms_XModel_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include <com/sun/star/beans/XPropertySet.idl> +#endif + +#ifndef __com_sun_star_container_XIndexAccess_idl__ +#include <com/sun/star/container/XSet.idl> +#endif + +#ifndef __com_sun_star_xforms_XDataTypeRepository_idl__ +#include <com/sun/star/xforms/XDataTypeRepository.idl> +#endif + +#ifndef __com_sun_star_xml_dom_XDocument_idl__ +#include <com/sun/star/xml/dom/XDocument.idl> +#endif + +#ifndef __com_sun_star_util_VetoException_idl__ +#include <com/sun/star/util/VetoException.idl> +#endif + +#ifndef __com_sun_star_lang_WrappedTargetException_idl__ +#include <com/sun/star/lang/WrappedTargetException.idl> +#endif + +#ifndef __com_sun_star_task_XInteractionHandler_idl__ +#include <com/sun/star/task/XInteractionHandler.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module xforms { + +interface XSubmission; + +//============================================================================= + +/** represent an XForms model + */ +interface XModel +{ + /** get the XForms model ID */ + string getID(); + + /** set the XForms model ID */ + void setID( [in] string id ); + + + /** initialize the model */ + void initialize(); + + /** rebuild the model */ + void rebuild(); + + /** re-evaluate all calculate attributes */ + void recalculate(); + + /** re-evaluate all validity attributes */ + void revalidate(); + + /** refresh the model */ + void refresh(); + + + /** submit form through given submission id + + <p>This is a convenience method. Calling it is equivalent to calling + <code><member>getSubmission</member>( <arg>id</arg> ).submit()</code>.</p> + + @param 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 + <member scope="com::sun::star::lang">WrappedTargetException::TargetException</type> describes + this error then. + */ + void submit( [in] string id ) + raises ( com::sun::star::util::VetoException, com::sun::star::lang::WrappedTargetException ); + + /** submit form through given submission id + + <p>This is a convenience method. Calling it is equivalent to calling + <code><member>getSubmission</member>( <arg>id</arg>, <arg>handler</arg> ).submit()</code>.</p> + + @param id + the ID of the submission to execute + + @param 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 + <member scope="com::sun::star::lang">WrappedTargetException::TargetException</type> describes + this error then. + */ + void submitWithInteraction( [in] string id, [in] com::sun::star::task::XInteractionHandler aHandler ) + raises ( com::sun::star::util::VetoException, com::sun::star::lang::WrappedTargetException ); + + /** provides management access to the XSD data types associated with the model + */ + XDataTypeRepository + getDataTypeRepository( ); + + + // + // instances + // + + /** gets container containing all instances; + + <p>The elements of the set are arrays of <type scope="com::sun::star::beans">PropertyValue</type>s, + containing the ID, the URL, and the instance itself.</p> + */ + com::sun::star::container::XSet getInstances(); + + /** retrieves the instance with the given id + */ + com::sun::star::xml::dom::XDocument getInstanceDocument( [in] string id ); + + /** get the default instance for this model + */ + com::sun::star::xml::dom::XDocument getDefaultInstance(); + + + // + // bindings + // + + /** create a binding element for this model + + <p>The returned binding still needs to be inserted into the bindings container.</p> + + @see getBindings + */ + com::sun::star::beans::XPropertySet createBinding(); + + /** clone an arbitrary binding element for this model; still needs + + <p>The returned binding still needs to be inserted into the bindings container.</p> + + @see getBindings + */ + com::sun::star::beans::XPropertySet cloneBinding( [in] com::sun::star::beans::XPropertySet binding ); + + /** get a binding with a certain ID + + <p>This is a convenience method: the same result can also be obtained through + <member>getBindings</member></p> + */ + com::sun::star::beans::XPropertySet getBinding( [in] string id ); + + /** get a container containing all bindings; also supports XNameAccess + */ + com::sun::star::container::XSet getBindings(); + + + // + // submissions + // + + /** create a submission element for this model + + <p>The returned submission element still needs to be inserted into the submission container.</p> + + @see getSubmissions + */ + XSubmission createSubmission(); + + /** clone an arbitrary submission element for this model + + <p>The returned submission element still needs to be inserted into the submission container.</p> + + @see getSubmissions + */ + XSubmission cloneSubmission( [in] com::sun::star::beans::XPropertySet submission ); + + /** get a submission with a certain ID. + + <p>This is a convenience method: the same result can also be obtained through + <member>getSubmissions</member>.</p> + */ + XSubmission getSubmission( [in] string id ); + + /** get container containing all submissions; also supports XNameAccess + */ + com::sun::star::container::XSet getSubmissions(); +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + +=============================================================================*/ +#endif |