1*cdf0e10cSrcweir/************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir#ifndef __com_sun_star_configuration_backend_XUpdateHandler_idl__ 28*cdf0e10cSrcweir#define __com_sun_star_configuration_backend_XUpdateHandler_idl__ 29*cdf0e10cSrcweir 30*cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 31*cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 32*cdf0e10cSrcweir#endif 33*cdf0e10cSrcweir 34*cdf0e10cSrcweir#ifndef __com_sun_star_configuration_backend_TemplateIdentifier_idl__ 35*cdf0e10cSrcweir#include <com/sun/star/configuration/backend/TemplateIdentifier.idl> 36*cdf0e10cSrcweir#endif 37*cdf0e10cSrcweir 38*cdf0e10cSrcweir#ifndef __com_sun_star_configuration_backend_MalformedDataException_idl__ 39*cdf0e10cSrcweir#include <com/sun/star/configuration/backend/MalformedDataException.idl> 40*cdf0e10cSrcweir#endif 41*cdf0e10cSrcweir 42*cdf0e10cSrcweir#ifndef __com_sun_star_lang_WrappedTargetException_idl__ 43*cdf0e10cSrcweir#include <com/sun/star/lang/WrappedTargetException.idl> 44*cdf0e10cSrcweir#endif 45*cdf0e10cSrcweir 46*cdf0e10cSrcweir#ifndef __com_sun_star_lang_IllegalAccessException_idl__ 47*cdf0e10cSrcweir#include <com/sun/star/lang/IllegalAccessException.idl> 48*cdf0e10cSrcweir#endif 49*cdf0e10cSrcweir 50*cdf0e10cSrcweir//============================================================================= 51*cdf0e10cSrcweir 52*cdf0e10cSrcweirmodule com { module sun { module star { module configuration { module backend { 53*cdf0e10cSrcweir 54*cdf0e10cSrcweir//============================================================================= 55*cdf0e10cSrcweir 56*cdf0e10cSrcweir/** receives a description of a configuration update or layer 57*cdf0e10cSrcweir as a sequence of events. 58*cdf0e10cSrcweir 59*cdf0e10cSrcweir @since OOo 1.1.2 60*cdf0e10cSrcweir */ 61*cdf0e10cSrcweirpublished interface XUpdateHandler: ::com::sun::star::uno::XInterface 62*cdf0e10cSrcweir{ 63*cdf0e10cSrcweir //------------------------------------------------------------------------- 64*cdf0e10cSrcweir 65*cdf0e10cSrcweir /** receives notification that a update or description is started. 66*cdf0e10cSrcweir 67*cdf0e10cSrcweir @throws com::sun::star::configuration::backend::MalformedDataException 68*cdf0e10cSrcweir if the update already was started 69*cdf0e10cSrcweir 70*cdf0e10cSrcweir @throws com::sun::star::lang::IllegalAccessException 71*cdf0e10cSrcweir if the target layer is read-only 72*cdf0e10cSrcweir <p><em>Some implementations can only detect this when executing 73*cdf0e10cSrcweir <member>XUpdateHandler::endUpdate()</member></em> 74*cdf0e10cSrcweir </p> 75*cdf0e10cSrcweir 76*cdf0e10cSrcweir @throws com::sun::star::lang::WrappedTargetException 77*cdf0e10cSrcweir if an error occurs processing the event. 78*cdf0e10cSrcweir */ 79*cdf0e10cSrcweir void startUpdate( ) 80*cdf0e10cSrcweir raises( MalformedDataException, 81*cdf0e10cSrcweir com::sun::star::lang::IllegalAccessException, 82*cdf0e10cSrcweir com::sun::star::lang::WrappedTargetException ); 83*cdf0e10cSrcweir //------------------------------------------------------------------------- 84*cdf0e10cSrcweir 85*cdf0e10cSrcweir /** receives notification that the current update description is complete. 86*cdf0e10cSrcweir 87*cdf0e10cSrcweir <p> Must match a previous call to <member>XUpdateHandler::startUpdate()</member>. 88*cdf0e10cSrcweir </p> 89*cdf0e10cSrcweir 90*cdf0e10cSrcweir @throws com::sun::star::configuration::backend::MalformedDataException 91*cdf0e10cSrcweir <ul> 92*cdf0e10cSrcweir <li>if no update is started at all</li> 93*cdf0e10cSrcweir <li>if invalid data is detected in the update</li> 94*cdf0e10cSrcweir <li>if there is an unfinished subnode in progress</li> 95*cdf0e10cSrcweir <li>if the update tries to change read-only data</li> 96*cdf0e10cSrcweir </ul> 97*cdf0e10cSrcweir <p><em>Not every implementation can detect each condition</em></p> 98*cdf0e10cSrcweir 99*cdf0e10cSrcweir @throws com::sun::star::lang::IllegalAccessException 100*cdf0e10cSrcweir if the target layer is read-only 101*cdf0e10cSrcweir 102*cdf0e10cSrcweir @throws com::sun::star::lang::WrappedTargetException 103*cdf0e10cSrcweir if an error occurs processing the event. 104*cdf0e10cSrcweir */ 105*cdf0e10cSrcweir void endUpdate( ) 106*cdf0e10cSrcweir raises( MalformedDataException, 107*cdf0e10cSrcweir com::sun::star::lang::IllegalAccessException, 108*cdf0e10cSrcweir com::sun::star::lang::WrappedTargetException ); 109*cdf0e10cSrcweir //------------------------------------------------------------------------- 110*cdf0e10cSrcweir 111*cdf0e10cSrcweir /** receives notification that a modification of a node is started. 112*cdf0e10cSrcweir 113*cdf0e10cSrcweir <p> Subsequent calls describe changes to properties and items or 114*cdf0e10cSrcweir members of the node until a matching call to 115*cdf0e10cSrcweir <member>XUpdateHandler::endNode()</member> is encountered. 116*cdf0e10cSrcweir </p> 117*cdf0e10cSrcweir 118*cdf0e10cSrcweir @param aName 119*cdf0e10cSrcweir specifies the name of the node. 120*cdf0e10cSrcweir 121*cdf0e10cSrcweir @param aAttributes 122*cdf0e10cSrcweir specifies attribute values to be applied to the node in the 123*cdf0e10cSrcweir current layer. 124*cdf0e10cSrcweir 125*cdf0e10cSrcweir <p> The value is a combination of 126*cdf0e10cSrcweir <type>NodeAttribute</type> flags. 127*cdf0e10cSrcweir </p> 128*cdf0e10cSrcweir <p> Only attributes which are selected in aAttributeMask 129*cdf0e10cSrcweir are changed. 130*cdf0e10cSrcweir </p> 131*cdf0e10cSrcweir 132*cdf0e10cSrcweir @param aAttributeMask 133*cdf0e10cSrcweir specifies which attributes should be changed for the node. 134*cdf0e10cSrcweir 135*cdf0e10cSrcweir <p> The value is a combination of 136*cdf0e10cSrcweir <type>NodeAttribute</type> flags. 137*cdf0e10cSrcweir </p> 138*cdf0e10cSrcweir 139*cdf0e10cSrcweir @param bReset 140*cdf0e10cSrcweir if <TRUE/>, specifies that the node should be reset to its default 141*cdf0e10cSrcweir state as given by lower layers and the schema or template prior 142*cdf0e10cSrcweir to applying the changes. 143*cdf0e10cSrcweir 144*cdf0e10cSrcweir @throws com::sun::star::configuration::backend::MalformedDataException 145*cdf0e10cSrcweir <ul> 146*cdf0e10cSrcweir <li>if there isn't an update in progress at all</li> 147*cdf0e10cSrcweir <li>if a node is not valid in this place</li> 148*cdf0e10cSrcweir <li>if there already was a change to that node</li> 149*cdf0e10cSrcweir <li>if there is no node with that name</li> 150*cdf0e10cSrcweir <li>if the node is read-only</li> 151*cdf0e10cSrcweir <li>if the name is not a valid node name</li> 152*cdf0e10cSrcweir <li>if the attributes or mask are not valid for the node</li> 153*cdf0e10cSrcweir </ul> 154*cdf0e10cSrcweir <p><em>Not every implementation can detect each condition</em></p> 155*cdf0e10cSrcweir 156*cdf0e10cSrcweir @throws com::sun::star::lang::WrappedTargetException 157*cdf0e10cSrcweir if an error occurs processing the event. 158*cdf0e10cSrcweir 159*cdf0e10cSrcweir @see com::sun::star::configuration::backend::NodeAttribute 160*cdf0e10cSrcweir */ 161*cdf0e10cSrcweir void modifyNode ( [in] string aName, 162*cdf0e10cSrcweir [in] short aAttributes, 163*cdf0e10cSrcweir [in] short aAttributeMask, 164*cdf0e10cSrcweir [in] boolean bReset ) 165*cdf0e10cSrcweir raises( MalformedDataException, 166*cdf0e10cSrcweir com::sun::star::lang::WrappedTargetException ); 167*cdf0e10cSrcweir //------------------------------------------------------------------------- 168*cdf0e10cSrcweir 169*cdf0e10cSrcweir /** receives notification that a node is started as a new item. 170*cdf0e10cSrcweir 171*cdf0e10cSrcweir <p> The current node must be a set and 172*cdf0e10cSrcweir a preexisting item (if any) must be removeable. 173*cdf0e10cSrcweir </p> 174*cdf0e10cSrcweir <p> The new item will be created from the default template 175*cdf0e10cSrcweir of the set. 176*cdf0e10cSrcweir </p> 177*cdf0e10cSrcweir <p> Subsequent calls describe the difference from the template 178*cdf0e10cSrcweir of properties, items or members of the node until a matching call 179*cdf0e10cSrcweir to <member>XUpdateHandler::endNode()</member> is encountered. 180*cdf0e10cSrcweir </p> 181*cdf0e10cSrcweir 182*cdf0e10cSrcweir @param aName 183*cdf0e10cSrcweir specifies the name of the new item. 184*cdf0e10cSrcweir 185*cdf0e10cSrcweir @param aAttributes 186*cdf0e10cSrcweir specifies attribute values to be applied to the new node. 187*cdf0e10cSrcweir 188*cdf0e10cSrcweir <p> The value is a combination of 189*cdf0e10cSrcweir <type>NodeAttribute</type> flags. Note that 190*cdf0e10cSrcweir <member>NodeAttribute::FUSE</member> has an impact on the 191*cdf0e10cSrcweir semantics of this method. 192*cdf0e10cSrcweir </p> 193*cdf0e10cSrcweir 194*cdf0e10cSrcweir @throws com::sun::star::configuration::backend::MalformedDataException 195*cdf0e10cSrcweir <ul> 196*cdf0e10cSrcweir <li>if there isn't a set node in progress currently</li> 197*cdf0e10cSrcweir <li>if there already was a change to an item of that name</li> 198*cdf0e10cSrcweir <li>if the template for the new node is not found</li> 199*cdf0e10cSrcweir <li>if an item of that name exists and is not removeable</li> 200*cdf0e10cSrcweir <li>if the name is not a valid item name</li> 201*cdf0e10cSrcweir <li>if the attributes are not valid for the node</li> 202*cdf0e10cSrcweir </ul> 203*cdf0e10cSrcweir <p><em>Not every implementation can detect each condition</em></p> 204*cdf0e10cSrcweir 205*cdf0e10cSrcweir @throws com::sun::star::lang::WrappedTargetException 206*cdf0e10cSrcweir if an error occurs processing the event. 207*cdf0e10cSrcweir 208*cdf0e10cSrcweir @see com::sun::star::configuration::backend::NodeAttribute 209*cdf0e10cSrcweir */ 210*cdf0e10cSrcweir void addOrReplaceNode ( [in] string aName, 211*cdf0e10cSrcweir [in] short aAttributes ) 212*cdf0e10cSrcweir raises( MalformedDataException, 213*cdf0e10cSrcweir com::sun::star::lang::WrappedTargetException ); 214*cdf0e10cSrcweir //------------------------------------------------------------------------- 215*cdf0e10cSrcweir 216*cdf0e10cSrcweir /** receives notification that a node is started as a new item 217*cdf0e10cSrcweir based on a particular template. 218*cdf0e10cSrcweir 219*cdf0e10cSrcweir <p> The current node must be a set and 220*cdf0e10cSrcweir a preexisting item (if any) must be removeable. 221*cdf0e10cSrcweir </p> 222*cdf0e10cSrcweir <p> Subsequent calls describe the difference from the template 223*cdf0e10cSrcweir of properties or members of the node until a matching call 224*cdf0e10cSrcweir to <member>XUpdateHandler::endNode()</member> is encountered. 225*cdf0e10cSrcweir </p> 226*cdf0e10cSrcweir 227*cdf0e10cSrcweir @param aName 228*cdf0e10cSrcweir specifies the name of the item. 229*cdf0e10cSrcweir 230*cdf0e10cSrcweir @param aTemplate 231*cdf0e10cSrcweir specifies the template to use for the new node 232*cdf0e10cSrcweir 233*cdf0e10cSrcweir @param aAttributes 234*cdf0e10cSrcweir specifies attribute values to be applied to the new node. 235*cdf0e10cSrcweir 236*cdf0e10cSrcweir <p> The value is a combination of 237*cdf0e10cSrcweir <type>NodeAttribute</type> flags. Note that 238*cdf0e10cSrcweir <member>NodeAttribute::FUSE</member> has an impact on the 239*cdf0e10cSrcweir semantics of this method. 240*cdf0e10cSrcweir </p> 241*cdf0e10cSrcweir 242*cdf0e10cSrcweir @throws com::sun::star::configuration::backend::MalformedDataException 243*cdf0e10cSrcweir <ul> 244*cdf0e10cSrcweir <li>if there isn't a set node in progress currently</li> 245*cdf0e10cSrcweir <li>if there already was a change to an item of that name</li> 246*cdf0e10cSrcweir <li>if the template for the new node is not found</li> 247*cdf0e10cSrcweir <li>if an item of that name exists and is not removeable</li> 248*cdf0e10cSrcweir <li>if the name is not a valid item name</li> 249*cdf0e10cSrcweir <li>if the template is not a valid item type for the containing set</li> 250*cdf0e10cSrcweir <li>if the attributes are not valid for the node</li> 251*cdf0e10cSrcweir </ul> 252*cdf0e10cSrcweir <p><em>Not every implementation can detect each condition</em></p> 253*cdf0e10cSrcweir 254*cdf0e10cSrcweir @throws com::sun::star::lang::WrappedTargetException 255*cdf0e10cSrcweir if an error occurs processing the event. 256*cdf0e10cSrcweir 257*cdf0e10cSrcweir @see com::sun::star::configuration::backend::NodeAttribute 258*cdf0e10cSrcweir */ 259*cdf0e10cSrcweir void addOrReplaceNodeFromTemplate( [in] string aName, 260*cdf0e10cSrcweir [in] short aAttributes, 261*cdf0e10cSrcweir [in] TemplateIdentifier aTemplate ) 262*cdf0e10cSrcweir raises( MalformedDataException, 263*cdf0e10cSrcweir com::sun::star::lang::WrappedTargetException ); 264*cdf0e10cSrcweir //------------------------------------------------------------------------- 265*cdf0e10cSrcweir 266*cdf0e10cSrcweir /** receives notification that a node modification is complete. 267*cdf0e10cSrcweir 268*cdf0e10cSrcweir <p> Must match the last open call to 269*cdf0e10cSrcweir <member>XUpdateHandler::modifyNode()</member>, 270*cdf0e10cSrcweir <member>XUpdateHandler::addOrReplaceNode()</member> or 271*cdf0e10cSrcweir <member>XUpdateHandler::addOrReplaceNodeFromTemplate()</member>. 272*cdf0e10cSrcweir </p> 273*cdf0e10cSrcweir 274*cdf0e10cSrcweir @throws com::sun::star::configuration::backend::MalformedDataException 275*cdf0e10cSrcweir <ul> 276*cdf0e10cSrcweir <li>if invalid data is detected in the node</li> 277*cdf0e10cSrcweir <li>if no node is started at all</li> 278*cdf0e10cSrcweir </ul> 279*cdf0e10cSrcweir <p><em>Not every implementation can detect each condition</em></p> 280*cdf0e10cSrcweir 281*cdf0e10cSrcweir @throws com::sun::star::lang::WrappedTargetException 282*cdf0e10cSrcweir if an error occurs processing the event. 283*cdf0e10cSrcweir */ 284*cdf0e10cSrcweir void endNode( ) 285*cdf0e10cSrcweir raises( MalformedDataException, 286*cdf0e10cSrcweir com::sun::star::lang::WrappedTargetException ); 287*cdf0e10cSrcweir //------------------------------------------------------------------------- 288*cdf0e10cSrcweir 289*cdf0e10cSrcweir /** receives notification that an item is to be dropped from a set. 290*cdf0e10cSrcweir 291*cdf0e10cSrcweir <p> The current node must be a set and 292*cdf0e10cSrcweir the item must be removeable. 293*cdf0e10cSrcweir </p> 294*cdf0e10cSrcweir 295*cdf0e10cSrcweir @param aName 296*cdf0e10cSrcweir specifies the name of the node. 297*cdf0e10cSrcweir 298*cdf0e10cSrcweir @throws com::sun::star::configuration::backend::MalformedDataException 299*cdf0e10cSrcweir <ul> 300*cdf0e10cSrcweir <li>if there isn't a set node in progress currently</li> 301*cdf0e10cSrcweir <li>if there already was a change to a node of that name</li> 302*cdf0e10cSrcweir <li>if there is no item with that name</li> 303*cdf0e10cSrcweir <li>if the item is not removeable</li> 304*cdf0e10cSrcweir <li>if the name is not a valid node name</li> 305*cdf0e10cSrcweir </ul> 306*cdf0e10cSrcweir <p><em>Not every implementation can detect each condition</em></p> 307*cdf0e10cSrcweir 308*cdf0e10cSrcweir @throws com::sun::star::lang::WrappedTargetException 309*cdf0e10cSrcweir if an error occurs processing the event. 310*cdf0e10cSrcweir */ 311*cdf0e10cSrcweir void removeNode( [in] string aName ) 312*cdf0e10cSrcweir raises( MalformedDataException, 313*cdf0e10cSrcweir com::sun::star::lang::WrappedTargetException ); 314*cdf0e10cSrcweir //------------------------------------------------------------------------- 315*cdf0e10cSrcweir 316*cdf0e10cSrcweir /** receives notification that modification of an existing property is started. . 317*cdf0e10cSrcweir 318*cdf0e10cSrcweir <p> Subsequent calls describe changes to the value(s) 319*cdf0e10cSrcweir of the property until a matching call to 320*cdf0e10cSrcweir <member>XUpdateHandler::endProperty()</member> is encountered. 321*cdf0e10cSrcweir </p> 322*cdf0e10cSrcweir 323*cdf0e10cSrcweir @param aName 324*cdf0e10cSrcweir specifies the name of the property. 325*cdf0e10cSrcweir 326*cdf0e10cSrcweir @param aAttributes 327*cdf0e10cSrcweir specifies new attributes of the property. 328*cdf0e10cSrcweir 329*cdf0e10cSrcweir <p> The value is a combination of 330*cdf0e10cSrcweir <type>NodeAttribute</type> flags. 331*cdf0e10cSrcweir </p> 332*cdf0e10cSrcweir <p> Only attributes which are selected in aAttributeMask are changed. 333*cdf0e10cSrcweir </p> 334*cdf0e10cSrcweir <p> <const>NodeAttribute::MANDATORY</const> need not be set 335*cdf0e10cSrcweir and can't be removed, as dynamic properties always are mandatory 336*cdf0e10cSrcweir in subsequent layers. 337*cdf0e10cSrcweir </p> 338*cdf0e10cSrcweir 339*cdf0e10cSrcweir @param aAttributeMask 340*cdf0e10cSrcweir specifies which attributes should be changed for the property. 341*cdf0e10cSrcweir 342*cdf0e10cSrcweir <p> The value is a combination of 343*cdf0e10cSrcweir <type>NodeAttribute</type> flags. 344*cdf0e10cSrcweir </p> 345*cdf0e10cSrcweir 346*cdf0e10cSrcweir @param aType 347*cdf0e10cSrcweir specifies the type of the property. 348*cdf0e10cSrcweir 349*cdf0e10cSrcweir <p> A <void/> type can be used to signify that 350*cdf0e10cSrcweir the type is unknown and should not be recorded. 351*cdf0e10cSrcweir </p> 352*cdf0e10cSrcweir 353*cdf0e10cSrcweir @throws com::sun::star::configuration::backend::MalformedDataException 354*cdf0e10cSrcweir <ul> 355*cdf0e10cSrcweir <li>if there isn't a group or extensible node in progress currently</li> 356*cdf0e10cSrcweir <li>if there already was a change to a property of that name</li> 357*cdf0e10cSrcweir <li>if there is no property with that name</li> 358*cdf0e10cSrcweir <li>if the property is read-only</li> 359*cdf0e10cSrcweir <li>if the name is not a valid property name</li> 360*cdf0e10cSrcweir <li>if the attributes are not valid for the property</li> 361*cdf0e10cSrcweir </ul> 362*cdf0e10cSrcweir <p><em>Not every implementation can detect each condition</em></p> 363*cdf0e10cSrcweir 364*cdf0e10cSrcweir @throws com::sun::star::lang::WrappedTargetException 365*cdf0e10cSrcweir if an error occurs processing the event. 366*cdf0e10cSrcweir 367*cdf0e10cSrcweir @see com::sun::star::configuration::backend::NodeAttribute 368*cdf0e10cSrcweir */ 369*cdf0e10cSrcweir void modifyProperty( [in] string aName, 370*cdf0e10cSrcweir [in] short aAttributes, 371*cdf0e10cSrcweir [in] short aAttributeMask, 372*cdf0e10cSrcweir [in] type aType ) 373*cdf0e10cSrcweir raises( MalformedDataException, 374*cdf0e10cSrcweir com::sun::star::lang::WrappedTargetException ); 375*cdf0e10cSrcweir //------------------------------------------------------------------------- 376*cdf0e10cSrcweir 377*cdf0e10cSrcweir /** receives notification about a change to the value of 378*cdf0e10cSrcweir the current property. 379*cdf0e10cSrcweir 380*cdf0e10cSrcweir @param aValue 381*cdf0e10cSrcweir specifies the new value of the property. 382*cdf0e10cSrcweir 383*cdf0e10cSrcweir <p> The value must match the type of the existing property. 384*cdf0e10cSrcweir If the property does not have the 385*cdf0e10cSrcweir <const>SchemaAttribute::REQUIRED</const> flag set, 386*cdf0e10cSrcweir the value can be <void/>. 387*cdf0e10cSrcweir </p> 388*cdf0e10cSrcweir 389*cdf0e10cSrcweir @throws com::sun::star::configuration::backend::MalformedDataException 390*cdf0e10cSrcweir <ul> 391*cdf0e10cSrcweir <li>if there isn't a property modification in progress currently</li> 392*cdf0e10cSrcweir <li>if there already was a change to this value</li> 393*cdf0e10cSrcweir <li>if the type of the value is not an allowed type</li> 394*cdf0e10cSrcweir <li>if the value is not valid for the property</li> 395*cdf0e10cSrcweir </ul> 396*cdf0e10cSrcweir <p><em>Not every implementation can detect each condition</em></p> 397*cdf0e10cSrcweir 398*cdf0e10cSrcweir @throws com::sun::star::lang::WrappedTargetException 399*cdf0e10cSrcweir if an error occurs processing the event. 400*cdf0e10cSrcweir 401*cdf0e10cSrcweir @see com::sun::star::configuration::backend::NodeAttribute 402*cdf0e10cSrcweir */ 403*cdf0e10cSrcweir void setPropertyValue( [in] any aValue ) 404*cdf0e10cSrcweir raises( MalformedDataException, 405*cdf0e10cSrcweir com::sun::star::lang::WrappedTargetException ); 406*cdf0e10cSrcweir //------------------------------------------------------------------------- 407*cdf0e10cSrcweir 408*cdf0e10cSrcweir /** receives notification about a change to the value of 409*cdf0e10cSrcweir the current property for a specific locale. 410*cdf0e10cSrcweir 411*cdf0e10cSrcweir @param aValue 412*cdf0e10cSrcweir specifies the new value of the property for the given locale. 413*cdf0e10cSrcweir 414*cdf0e10cSrcweir <p> The value must match the type of the existing property. 415*cdf0e10cSrcweir If the property does not have the 416*cdf0e10cSrcweir <const>SchemaAttribute::REQUIRED</const> flag set, 417*cdf0e10cSrcweir the value can be <void/>. 418*cdf0e10cSrcweir </p> 419*cdf0e10cSrcweir 420*cdf0e10cSrcweir @param aLocale 421*cdf0e10cSrcweir specifies the locale that the new value applies to. 422*cdf0e10cSrcweir 423*cdf0e10cSrcweir @throws com::sun::star::configuration::backend::MalformedDataException 424*cdf0e10cSrcweir <ul> 425*cdf0e10cSrcweir <li>if there isn't a property modification in progress currently</li> 426*cdf0e10cSrcweir <li>if the property is not localizable</li> 427*cdf0e10cSrcweir <li>if there already was a change to this value</li> 428*cdf0e10cSrcweir <li>if the type of the value is not an allowed type</li> 429*cdf0e10cSrcweir <li>if the value is not valid for the property</li> 430*cdf0e10cSrcweir <li>if the locale is not a valid locale name</li> 431*cdf0e10cSrcweir </ul> 432*cdf0e10cSrcweir <p><em>Not every implementation can detect each condition</em></p> 433*cdf0e10cSrcweir 434*cdf0e10cSrcweir @throws com::sun::star::lang::WrappedTargetException 435*cdf0e10cSrcweir if an error occurs processing the event. 436*cdf0e10cSrcweir 437*cdf0e10cSrcweir @see com::sun::star::configuration::backend::NodeAttribute 438*cdf0e10cSrcweir */ 439*cdf0e10cSrcweir void setPropertyValueForLocale( [in] any aValue, [in] string aLocale ) 440*cdf0e10cSrcweir raises( MalformedDataException, 441*cdf0e10cSrcweir com::sun::star::lang::WrappedTargetException ); 442*cdf0e10cSrcweir //------------------------------------------------------------------------- 443*cdf0e10cSrcweir 444*cdf0e10cSrcweir /** receives notification that the value of the current property 445*cdf0e10cSrcweir should be reset to its default. 446*cdf0e10cSrcweir 447*cdf0e10cSrcweir @throws com::sun::star::configuration::backend::MalformedDataException 448*cdf0e10cSrcweir <ul> 449*cdf0e10cSrcweir <li>if there isn't a property modification in progress currently</li> 450*cdf0e10cSrcweir <li>if there already was a change to this value</li> 451*cdf0e10cSrcweir </ul> 452*cdf0e10cSrcweir <p><em>Not every implementation can detect each condition</em></p> 453*cdf0e10cSrcweir 454*cdf0e10cSrcweir @throws com::sun::star::lang::WrappedTargetException 455*cdf0e10cSrcweir if an error occurs processing the event. 456*cdf0e10cSrcweir 457*cdf0e10cSrcweir @see com::sun::star::configuration::backend::NodeAttribute 458*cdf0e10cSrcweir */ 459*cdf0e10cSrcweir void resetPropertyValue( ) 460*cdf0e10cSrcweir raises( MalformedDataException, 461*cdf0e10cSrcweir com::sun::star::lang::WrappedTargetException ); 462*cdf0e10cSrcweir //------------------------------------------------------------------------- 463*cdf0e10cSrcweir 464*cdf0e10cSrcweir /** receives notification that the value of the current property 465*cdf0e10cSrcweir for a specific locale should be reset to its default. 466*cdf0e10cSrcweir 467*cdf0e10cSrcweir @param aLocale 468*cdf0e10cSrcweir specifies the locale the change applies to. 469*cdf0e10cSrcweir 470*cdf0e10cSrcweir @throws com::sun::star::configuration::backend::MalformedDataException 471*cdf0e10cSrcweir <ul> 472*cdf0e10cSrcweir <li>if there isn't a property modification in progress currently</li> 473*cdf0e10cSrcweir <li>if the property is not localizable</li> 474*cdf0e10cSrcweir <li>if there already was a change to this value</li> 475*cdf0e10cSrcweir <li>if the locale is not a valid locale name</li> 476*cdf0e10cSrcweir </ul> 477*cdf0e10cSrcweir <p><em>Not every implementation can detect each condition</em></p> 478*cdf0e10cSrcweir 479*cdf0e10cSrcweir @throws com::sun::star::lang::WrappedTargetException 480*cdf0e10cSrcweir if an error occurs processing the event. 481*cdf0e10cSrcweir 482*cdf0e10cSrcweir @see com::sun::star::configuration::backend::NodeAttribute 483*cdf0e10cSrcweir */ 484*cdf0e10cSrcweir void resetPropertyValueForLocale( [in] string aLocale ) 485*cdf0e10cSrcweir raises( MalformedDataException, 486*cdf0e10cSrcweir com::sun::star::lang::WrappedTargetException ); 487*cdf0e10cSrcweir //------------------------------------------------------------------------- 488*cdf0e10cSrcweir 489*cdf0e10cSrcweir /** receives notification that a property modification is complete. 490*cdf0e10cSrcweir 491*cdf0e10cSrcweir <p> Must match the last open call to 492*cdf0e10cSrcweir <member>XUpdateHandler::modifyProperty()</member>. 493*cdf0e10cSrcweir </p> 494*cdf0e10cSrcweir 495*cdf0e10cSrcweir @throws com::sun::star::configuration::backend::MalformedDataException 496*cdf0e10cSrcweir <ul> 497*cdf0e10cSrcweir <li>if invalid data is detected in the property</li> 498*cdf0e10cSrcweir <li>if no property is started at all</li> 499*cdf0e10cSrcweir </ul> 500*cdf0e10cSrcweir <p><em>Not every implementation can detect each condition</em></p> 501*cdf0e10cSrcweir 502*cdf0e10cSrcweir @throws com::sun::star::lang::WrappedTargetException 503*cdf0e10cSrcweir if an error occurs processing the event. 504*cdf0e10cSrcweir */ 505*cdf0e10cSrcweir void endProperty( ) 506*cdf0e10cSrcweir raises( MalformedDataException, 507*cdf0e10cSrcweir com::sun::star::lang::WrappedTargetException ); 508*cdf0e10cSrcweir //------------------------------------------------------------------------- 509*cdf0e10cSrcweir 510*cdf0e10cSrcweir /** receives notification that a property is reset to its default state. 511*cdf0e10cSrcweir 512*cdf0e10cSrcweir @param aName 513*cdf0e10cSrcweir specifies the name of the property. 514*cdf0e10cSrcweir 515*cdf0e10cSrcweir @throws com::sun::star::configuration::backend::MalformedDataException 516*cdf0e10cSrcweir <ul> 517*cdf0e10cSrcweir <li>if there isn't a group or extensible node in progress currently</li> 518*cdf0e10cSrcweir <li>if there already was a change to a property of that name</li> 519*cdf0e10cSrcweir <li>if there is no property with that name, or if the property 520*cdf0e10cSrcweir has no default</li> 521*cdf0e10cSrcweir <li>if the property is read-only</li> 522*cdf0e10cSrcweir <li>if the name is not a valid property name</li> 523*cdf0e10cSrcweir </ul> 524*cdf0e10cSrcweir <p><em>Not every implementation can detect each condition</em></p> 525*cdf0e10cSrcweir 526*cdf0e10cSrcweir @throws com::sun::star::lang::WrappedTargetException 527*cdf0e10cSrcweir if an error occurs processing the event. 528*cdf0e10cSrcweir 529*cdf0e10cSrcweir @see com::sun::star::configuration::backend::NodeAttribute 530*cdf0e10cSrcweir */ 531*cdf0e10cSrcweir void resetProperty( [in] string aName ) 532*cdf0e10cSrcweir raises( MalformedDataException, 533*cdf0e10cSrcweir com::sun::star::lang::WrappedTargetException ); 534*cdf0e10cSrcweir //------------------------------------------------------------------------- 535*cdf0e10cSrcweir 536*cdf0e10cSrcweir /** receives notification that a property having a value of <void/> 537*cdf0e10cSrcweir is added to the current node. 538*cdf0e10cSrcweir 539*cdf0e10cSrcweir <p> The current node must be extensible and 540*cdf0e10cSrcweir a preexisting property (if any) must be 541*cdf0e10cSrcweir removeable in this layer. 542*cdf0e10cSrcweir </p> 543*cdf0e10cSrcweir 544*cdf0e10cSrcweir @param aName 545*cdf0e10cSrcweir specifies the name of the new property. 546*cdf0e10cSrcweir 547*cdf0e10cSrcweir @param aAttributes 548*cdf0e10cSrcweir specifies the attributes of the new property. 549*cdf0e10cSrcweir 550*cdf0e10cSrcweir <p> The value is a combination of 551*cdf0e10cSrcweir <type>NodeAttribute</type> flags and may also contain the 552*cdf0e10cSrcweir <const>SchemaAttribute::REQUIRED</const> flag. 553*cdf0e10cSrcweir </p> 554*cdf0e10cSrcweir </p> 555*cdf0e10cSrcweir <p> <const>NodeAttribute::MANDATORY</const> need not be set, 556*cdf0e10cSrcweir as dynamic properties always are mandatory 557*cdf0e10cSrcweir in subsequent layers. 558*cdf0e10cSrcweir </p> 559*cdf0e10cSrcweir 560*cdf0e10cSrcweir @param aType 561*cdf0e10cSrcweir specifies the type of the new property. 562*cdf0e10cSrcweir 563*cdf0e10cSrcweir @throws com::sun::star::configuration::backend::MalformedDataException 564*cdf0e10cSrcweir <ul> 565*cdf0e10cSrcweir <li>if there isn't a group or extensible node in progress currently</li> 566*cdf0e10cSrcweir <li>if there already was a change to a property of that name</li> 567*cdf0e10cSrcweir <li>if a property of that name exists and is not removeable</li> 568*cdf0e10cSrcweir <li>if the specified type is not allowed</li> 569*cdf0e10cSrcweir <li>if the name is not a valid property name</li> 570*cdf0e10cSrcweir <li>if the attributes are not valid for the property</li> 571*cdf0e10cSrcweir </ul> 572*cdf0e10cSrcweir <p><em>Not every implementation can detect each condition</em></p> 573*cdf0e10cSrcweir 574*cdf0e10cSrcweir @throws com::sun::star::lang::WrappedTargetException 575*cdf0e10cSrcweir if an error occurs processing the event. 576*cdf0e10cSrcweir 577*cdf0e10cSrcweir @see com::sun::star::configuration::backend::SchemaAttribute 578*cdf0e10cSrcweir */ 579*cdf0e10cSrcweir void addOrReplaceProperty( [in] string aName, 580*cdf0e10cSrcweir [in] short aAttributes, 581*cdf0e10cSrcweir [in] type aType ) 582*cdf0e10cSrcweir raises( MalformedDataException, 583*cdf0e10cSrcweir com::sun::star::lang::WrappedTargetException ); 584*cdf0e10cSrcweir //------------------------------------------------------------------------- 585*cdf0e10cSrcweir 586*cdf0e10cSrcweir /** receives notification that a property having a non-<NULL/> value 587*cdf0e10cSrcweir is added to the current node. 588*cdf0e10cSrcweir 589*cdf0e10cSrcweir <p> The current node must be extensible and 590*cdf0e10cSrcweir a preexisting property (if any) must be 591*cdf0e10cSrcweir removeable in this layer. 592*cdf0e10cSrcweir </p> 593*cdf0e10cSrcweir 594*cdf0e10cSrcweir @param aName 595*cdf0e10cSrcweir specifies the name of the new property. 596*cdf0e10cSrcweir 597*cdf0e10cSrcweir @param aAttributes 598*cdf0e10cSrcweir specifies the attributes of the new property. 599*cdf0e10cSrcweir 600*cdf0e10cSrcweir <p> The value is a combination of 601*cdf0e10cSrcweir <type>NodeAttribute</type> flags and may also contain the 602*cdf0e10cSrcweir <const>SchemaAttribute::REQUIRED</const> flag. 603*cdf0e10cSrcweir </p> 604*cdf0e10cSrcweir </p> 605*cdf0e10cSrcweir <p> <const>NodeAttribute::MANDATORY</const> need not be set, 606*cdf0e10cSrcweir as dynamic properties always are mandatory 607*cdf0e10cSrcweir in subsequent layers. 608*cdf0e10cSrcweir </p> 609*cdf0e10cSrcweir 610*cdf0e10cSrcweir @param aValue 611*cdf0e10cSrcweir specifies the value of the new property. 612*cdf0e10cSrcweir 613*cdf0e10cSrcweir <p> The value also determines the type. 614*cdf0e10cSrcweir Therefore the value must not be <void/>. 615*cdf0e10cSrcweir </p> 616*cdf0e10cSrcweir 617*cdf0e10cSrcweir @throws com::sun::star::configuration::backend::MalformedDataException 618*cdf0e10cSrcweir <ul> 619*cdf0e10cSrcweir <li>if there isn't a group or extensible node in progress currently</li> 620*cdf0e10cSrcweir <li>if there already was a change to a property of that name</li> 621*cdf0e10cSrcweir <li>if a property of that name exists and is not removeable</li> 622*cdf0e10cSrcweir <li>if the type of the value is not an allowed type, 623*cdf0e10cSrcweir or if the value is <void/></li> 624*cdf0e10cSrcweir <li>if the name is not a valid property name</li> 625*cdf0e10cSrcweir <li>if the attributes are not valid for the property</li> 626*cdf0e10cSrcweir </ul> 627*cdf0e10cSrcweir <p><em>Not every implementation can detect each condition</em></p> 628*cdf0e10cSrcweir 629*cdf0e10cSrcweir @throws com::sun::star::lang::WrappedTargetException 630*cdf0e10cSrcweir if an error occurs processing the event. 631*cdf0e10cSrcweir 632*cdf0e10cSrcweir @see com::sun::star::configuration::backend::SchemaAttribute 633*cdf0e10cSrcweir */ 634*cdf0e10cSrcweir void addOrReplacePropertyWithValue( [in] string aName, 635*cdf0e10cSrcweir [in] short aAttributes, 636*cdf0e10cSrcweir [in] any aValue ) 637*cdf0e10cSrcweir raises( MalformedDataException, 638*cdf0e10cSrcweir com::sun::star::lang::WrappedTargetException ); 639*cdf0e10cSrcweir //------------------------------------------------------------------------- 640*cdf0e10cSrcweir 641*cdf0e10cSrcweir /** receives notification that a property is dropped from the current node. 642*cdf0e10cSrcweir 643*cdf0e10cSrcweir <p>The current node must be extensible and the property removeable.</p> 644*cdf0e10cSrcweir 645*cdf0e10cSrcweir @param aName 646*cdf0e10cSrcweir specifies the name of the property. 647*cdf0e10cSrcweir 648*cdf0e10cSrcweir @throws com::sun::star::configuration::backend::MalformedDataException 649*cdf0e10cSrcweir <ul> 650*cdf0e10cSrcweir <li>if there isn't a group or extensible node in progress currently</li> 651*cdf0e10cSrcweir <li>if there is no property with that name</li> 652*cdf0e10cSrcweir <li>if the property is not removeable</li> 653*cdf0e10cSrcweir <li>if the name is not a valid node name</li> 654*cdf0e10cSrcweir </ul> 655*cdf0e10cSrcweir <p><em>Not every implementation can detect each condition</em></p> 656*cdf0e10cSrcweir 657*cdf0e10cSrcweir @throws com::sun::star::lang::WrappedTargetException 658*cdf0e10cSrcweir if an error occurs processing the event. 659*cdf0e10cSrcweir */ 660*cdf0e10cSrcweir void removeProperty( [in] string aName ) 661*cdf0e10cSrcweir raises( MalformedDataException, 662*cdf0e10cSrcweir com::sun::star::lang::WrappedTargetException ); 663*cdf0e10cSrcweir //------------------------------------------------------------------------- 664*cdf0e10cSrcweir 665*cdf0e10cSrcweir}; 666*cdf0e10cSrcweir 667*cdf0e10cSrcweir//============================================================================= 668*cdf0e10cSrcweir 669*cdf0e10cSrcweir}; }; }; }; }; 670*cdf0e10cSrcweir 671*cdf0e10cSrcweir//============================================================================= 672*cdf0e10cSrcweir 673*cdf0e10cSrcweir#endif 674