offapi/com/sun/star/xforms/XModel.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_xforms_XModel_idl__
  20 #define __com_sun_star_xforms_XModel_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/beans/XPropertySet.idl>
  25 #include <com/sun/star/container/XSet.idl>
  26 #include <com/sun/star/xforms/XDataTypeRepository.idl>
  27 #include <com/sun/star/xml/dom/XDocument.idl>
  28 #include <com/sun/star/util/VetoException.idl>
  29 #include <com/sun/star/lang/WrappedTargetException.idl>
  30 #include <com/sun/star/task/XInteractionHandler.idl>
  31
  32
  33 module com {  module sun {  module star {  module xforms {
  34
  35 interface XSubmission;
  36
  37
  38 /** represent an XForms model
  39  */
  40 interface XModel
  41 {
  42     /** get the XForms model ID */
  43     string getID();
  44
  45     /** set the XForms model ID */
  46     void setID( [in] string id );
  47
  48
  49     /** initialize the model */
  50     void initialize();
  51
  52     /** rebuild the model */
  53     void rebuild();
  54
  55     /** re-evaluate all calculate attributes */
  56     void recalculate();
  57
  58     /** re-evaluate all validity attributes */
  59     void revalidate();
  60
  61     /** refresh the model */
  62     void refresh();
  63
  64
  65     /** submit form through given submission id
  66
  67         <p>This is a convenience method. Calling it is equivalent to calling
  68         <code>getSubmission()( id ).submit()</code>.</p>
  69
  70         @param id
  71             the ID of the submission to execute
  72
  73         @throws com::sun::star::util::VetoException
  74             when the current model state does not allow a submission. Usually, this indicates that
  75             consistency criteria for the model data is not fulfilled.
  76
  77         @throws com::sun::star::lang::WrappedTargetException
  78             when another error occurred during the submission. The
  79             com::sun::star::lang::WrappedTargetException::TargetException describes
  80             this error then.
  81     */
  82     void submit( [in] string id )
  83         raises ( com::sun::star::util::VetoException, com::sun::star::lang::WrappedTargetException );
  84
  85     /** submit form through given submission id
  86
  87         <p>This is a convenience method. Calling it is equivalent to calling
  88         <code>getSubmission()( id, handler ).submit()</code>.</p>
  89
  90         @param id
  91             the ID of the submission to execute
  92
  93         @param aHandler
  94             This handler allows additional user interaction, which may be necessary before
  95             the submission can be performed.
  96
  97         @throws com::sun::star::util::VetoException
  98             when the current model state does not allow a submission. Usually, this indicates that
  99             consistency criteria for the model data is not fulfilled.
 100
 101         @throws com::sun::star::lang::WrappedTargetException
 102             when another error occurred during the submission. The
 103             com::sun::star::lang::WrappedTargetException::TargetException describes
 104             this error then.
 105     */
 106     void submitWithInteraction( [in] string id, [in] com::sun::star::task::XInteractionHandler aHandler )
 107         raises ( com::sun::star::util::VetoException, com::sun::star::lang::WrappedTargetException );
 108
 109     /** provides management access to the XSD data types associated with the model
 110     */
 111     XDataTypeRepository
 112         getDataTypeRepository( );
 113
 114
 115     // instances
 116
 117     /** gets container containing all instances;
 118
 119         <p>The elements of the set are arrays of com::sun::star::beans::PropertyValues,
 120         containing the ID, the URL, and the instance itself.</p>
 121     */
 122     com::sun::star::container::XSet getInstances();
 123
 124     /** retrieves the instance with the given id
 125     */
 126     com::sun::star::xml::dom::XDocument getInstanceDocument( [in] string id );
 127
 128     /** get the default instance for this model
 129     */
 130     com::sun::star::xml::dom::XDocument getDefaultInstance();
 131
 132
 133     // bindings
 134
 135     /** create a binding element for this model
 136
 137         <p>The returned binding still needs to be inserted into the bindings container.</p>
 138
 139         @see getBindings
 140     */
 141     com::sun::star::beans::XPropertySet createBinding();
 142
 143     /** clone an arbitrary binding element for this model; still needs
 144
 145         <p>The returned binding still needs to be inserted into the bindings container.</p>
 146
 147         @see getBindings
 148     */
 149     com::sun::star::beans::XPropertySet cloneBinding( [in] com::sun::star::beans::XPropertySet binding );
 150
 151     /** get a binding with a certain ID
 152
 153         <p>This is a convenience method: the same result can also be obtained through
 154         getBindings()</p>
 155     */
 156     com::sun::star::beans::XPropertySet getBinding( [in] string id );
 157
 158     /** get a container containing all bindings; also supports XNameAccess
 159     */
 160     com::sun::star::container::XSet getBindings();
 161
 162
 163     // submissions
 164
 165     /** create a submission element for this model
 166
 167         <p>The returned submission element still needs to be inserted into the submission container.</p>
 168
 169         @see getSubmissions
 170     */
 171     XSubmission createSubmission();
 172
 173     /** clone an arbitrary submission element for this model
 174
 175         <p>The returned submission element still needs to be inserted into the submission container.</p>
 176
 177         @see getSubmissions
 178     */
 179     XSubmission cloneSubmission( [in] com::sun::star::beans::XPropertySet submission );
 180
 181     /** get a submission with a certain ID.
 182
 183         <p>This is a convenience method: the same result can also be obtained through
 184         getSubmissions().</p>
 185     */
 186     XSubmission getSubmission( [in] string id );
 187
 188     /** get container containing all submissions; also supports XNameAccess
 189     */
 190     com::sun::star::container::XSet getSubmissions();
 191 };
 192
 193
 194 }; }; }; };
 195
 196 #endif
 197
 198 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */