1*408a4873SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*408a4873SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*408a4873SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*408a4873SAndrew Rist * distributed with this work for additional information 6*408a4873SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*408a4873SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*408a4873SAndrew Rist * "License"); you may not use this file except in compliance 9*408a4873SAndrew Rist * with the License. You may obtain a copy of the License at 10*408a4873SAndrew Rist * 11*408a4873SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*408a4873SAndrew Rist * 13*408a4873SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*408a4873SAndrew Rist * software distributed under the License is distributed on an 15*408a4873SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*408a4873SAndrew Rist * KIND, either express or implied. See the License for the 17*408a4873SAndrew Rist * specific language governing permissions and limitations 18*408a4873SAndrew Rist * under the License. 19*408a4873SAndrew Rist * 20*408a4873SAndrew Rist *************************************************************/ 21*408a4873SAndrew Rist 22*408a4873SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_beans_XMultiHierarchicalPropertySet_idl__ 24cdf0e10cSrcweir#define __com_sun_star_beans_XMultiHierarchicalPropertySet_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir#ifndef __com_sun_star_beans_XHierarchicalPropertySetInfo_idl__ 31cdf0e10cSrcweir#include <com/sun/star/beans/XHierarchicalPropertySetInfo.idl> 32cdf0e10cSrcweir#endif 33cdf0e10cSrcweir 34cdf0e10cSrcweir#ifndef __com_sun_star_beans_PropertyVetoException_idl__ 35cdf0e10cSrcweir#include <com/sun/star/beans/PropertyVetoException.idl> 36cdf0e10cSrcweir#endif 37cdf0e10cSrcweir 38cdf0e10cSrcweir#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 39cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl> 40cdf0e10cSrcweir#endif 41cdf0e10cSrcweir 42cdf0e10cSrcweir#ifndef __com_sun_star_lang_WrappedTargetException_idl__ 43cdf0e10cSrcweir#include <com/sun/star/lang/WrappedTargetException.idl> 44cdf0e10cSrcweir#endif 45cdf0e10cSrcweir 46cdf0e10cSrcweir//============================================================================= 47cdf0e10cSrcweir 48cdf0e10cSrcweirmodule com { module sun { module star { module beans { 49cdf0e10cSrcweir 50cdf0e10cSrcweir//============================================================================= 51cdf0e10cSrcweir 52cdf0e10cSrcweir/** provides access to multiple properties which form a hierarchy. 53cdf0e10cSrcweir 54cdf0e10cSrcweir @see XHierarchicalPropertySet 55cdf0e10cSrcweir */ 56cdf0e10cSrcweirpublished interface XMultiHierarchicalPropertySet: com::sun::star::uno::XInterface 57cdf0e10cSrcweir{ 58cdf0e10cSrcweir //------------------------------------------------------------------------- 59cdf0e10cSrcweir 60cdf0e10cSrcweir /** retrieve information about the hierarchy of properties 61cdf0e10cSrcweir 62cdf0e10cSrcweir @returns 63cdf0e10cSrcweir the <type>XHierarchicalPropertySetInfo</type> interface, 64cdf0e10cSrcweir which describes the property hierarchy of the object which 65cdf0e10cSrcweir supplies this interface. 66cdf0e10cSrcweir 67cdf0e10cSrcweir @returns 68cdf0e10cSrcweir <NULL/> if the implementation cannot or will 69cdf0e10cSrcweir not provide information about the properties; otherwise the 70cdf0e10cSrcweir interface <type>XHierarchicalPropertySetInfo</type> is returned. 71cdf0e10cSrcweir 72cdf0e10cSrcweir @see XHierarchicalPropertySet::getHierarchicalPropertySetInfo 73cdf0e10cSrcweir */ 74cdf0e10cSrcweir com::sun::star::beans::XHierarchicalPropertySetInfo getHierarchicalPropertySetInfo(); 75cdf0e10cSrcweir 76cdf0e10cSrcweir //------------------------------------------------------------------------- 77cdf0e10cSrcweir 78cdf0e10cSrcweir /** sets the values of the properties with the specified nested names. 79cdf0e10cSrcweir 80cdf0e10cSrcweir <p> The values of the properties must change before bound 81cdf0e10cSrcweir events are fired. The values of constrained properties 82cdf0e10cSrcweir should change after the vetoable events are fired, if no 83cdf0e10cSrcweir exception occurs. </p> 84cdf0e10cSrcweir 85cdf0e10cSrcweir <p> Unknown properties are ignored. </p> 86cdf0e10cSrcweir 87cdf0e10cSrcweir @param aHierarchicalPropertyNames 88cdf0e10cSrcweir This parameter specifies the names of the properties. 89cdf0e10cSrcweir 90cdf0e10cSrcweir @param aValues 91cdf0e10cSrcweir This parameter specifies the new values for the properties. 92cdf0e10cSrcweir 93cdf0e10cSrcweir @throws PropertyVetoException 94cdf0e10cSrcweir if one of the properties is constrained and the change is 95cdf0e10cSrcweir vetoed by a <type>XVetoableChangeListener</type>. 96cdf0e10cSrcweir 97cdf0e10cSrcweir @throws com::sun::star::lang::IllegalArgumentException 98cdf0e10cSrcweir if one of the values is not a legal value for the 99cdf0e10cSrcweir corresponding property or if one of the names 100cdf0e10cSrcweir is not a well-formed nested name for this hierarchy. 101cdf0e10cSrcweir An implementation is not required to detect the latter 102cdf0e10cSrcweir condition. 103cdf0e10cSrcweir 104cdf0e10cSrcweir @throws com::sun::star::lang::WrappedTargetException 105cdf0e10cSrcweir if the implementation has an internal reason for the exception. 106cdf0e10cSrcweir In this case the original exception is wrapped into that 107cdf0e10cSrcweir <type scope="com::sun::star::lang">WrappedTargetException</type>. 108cdf0e10cSrcweir 109cdf0e10cSrcweir @see XHierarchicalPropertySet::setHierarchicalPropertyValue 110cdf0e10cSrcweir @see XMultiPropertySet::setPropertyValues 111cdf0e10cSrcweir */ 112cdf0e10cSrcweir 113cdf0e10cSrcweir 114cdf0e10cSrcweir void setHierarchicalPropertyValues( [in] sequence<string> aHierarchicalPropertyNames, 115cdf0e10cSrcweir [in] sequence<any> Values ) 116cdf0e10cSrcweir raises( com::sun::star::beans::PropertyVetoException, 117cdf0e10cSrcweir com::sun::star::lang::IllegalArgumentException, 118cdf0e10cSrcweir com::sun::star::lang::WrappedTargetException ); 119cdf0e10cSrcweir 120cdf0e10cSrcweir //------------------------------------------------------------------------- 121cdf0e10cSrcweir 122cdf0e10cSrcweir /** @returns 123cdf0e10cSrcweir a sequence of all values of the properties which are specified 124cdf0e10cSrcweir by their nested names. 125cdf0e10cSrcweir 126cdf0e10cSrcweir <p> The order of the values in the returned sequence will be the same 127cdf0e10cSrcweir as the order of the names in the argument. </p> 128cdf0e10cSrcweir 129cdf0e10cSrcweir <p> Unknown properties are ignored, in their place <NULL/> will be returned. </p> 130cdf0e10cSrcweir 131cdf0e10cSrcweir @throws com::sun::star::lang::IllegalArgumentException 132cdf0e10cSrcweir if one of the names is not a well-formed 133cdf0e10cSrcweir nested name for this hierarchy. 134cdf0e10cSrcweir An implementation is not required to detect this 135cdf0e10cSrcweir condition. 136cdf0e10cSrcweir 137cdf0e10cSrcweir @throws com::sun::star::lang::WrappedTargetException 138cdf0e10cSrcweir if the implementation has an internal reason for the exception. 139cdf0e10cSrcweir In this case the original exception is wrapped into that 140cdf0e10cSrcweir <type scope="com::sun::star::lang">WrappedTargetException</type>. 141cdf0e10cSrcweir 142cdf0e10cSrcweir @see XHierarchicalPropertySet::getHierarchicalPropertyValue 143cdf0e10cSrcweir @see XMultiPropertySet::setPropertyValues 144cdf0e10cSrcweir */ 145cdf0e10cSrcweir sequence<any> getHierarchicalPropertyValues( [in] sequence<string> aPropertyNames ) 146cdf0e10cSrcweir raises( com::sun::star::lang::IllegalArgumentException , 147cdf0e10cSrcweir com::sun::star::lang::WrappedTargetException ); 148cdf0e10cSrcweir 149cdf0e10cSrcweir //------------------------------------------------------------------------- 150cdf0e10cSrcweir 151cdf0e10cSrcweir}; 152cdf0e10cSrcweir 153cdf0e10cSrcweir//============================================================================= 154cdf0e10cSrcweir 155cdf0e10cSrcweir}; }; }; }; 156cdf0e10cSrcweir 157cdf0e10cSrcweir#endif 158