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 28*cdf0e10cSrcweir#ifndef __com_sun_star_container_XStringKeyMap_idl__ 29*cdf0e10cSrcweir#define __com_sun_star_container_XStringKeyMap_idl__ 30*cdf0e10cSrcweir 31*cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 32*cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 33*cdf0e10cSrcweir#endif 34*cdf0e10cSrcweir 35*cdf0e10cSrcweir#ifndef __com_sun_star_lang_IndexOutOfBoundsException_idl__ 36*cdf0e10cSrcweir#include <com/sun/star/lang/IndexOutOfBoundsException.idl> 37*cdf0e10cSrcweir#endif 38*cdf0e10cSrcweir 39*cdf0e10cSrcweir#ifndef __com_sun_star_container_ElementExistException_idl__ 40*cdf0e10cSrcweir#include <com/sun/star/container/ElementExistException.idl> 41*cdf0e10cSrcweir#endif 42*cdf0e10cSrcweir 43*cdf0e10cSrcweir#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 44*cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl> 45*cdf0e10cSrcweir#endif 46*cdf0e10cSrcweir 47*cdf0e10cSrcweir#ifndef __com_sun_star_container_NoSuchElementException_idl__ 48*cdf0e10cSrcweir#include <com/sun/star/container/NoSuchElementException.idl> 49*cdf0e10cSrcweir#endif 50*cdf0e10cSrcweir 51*cdf0e10cSrcweir//============================================================================= 52*cdf0e10cSrcweir 53*cdf0e10cSrcweirmodule com { module sun { module star { module container { 54*cdf0e10cSrcweir 55*cdf0e10cSrcweir//============================================================================= 56*cdf0e10cSrcweir 57*cdf0e10cSrcweir/** maps strings to anys. 58*cdf0e10cSrcweir 59*cdf0e10cSrcweir @since OOo 2.3 60*cdf0e10cSrcweir */ 61*cdf0e10cSrcweir 62*cdf0e10cSrcweirinterface XStringKeyMap 63*cdf0e10cSrcweir{ 64*cdf0e10cSrcweir //------------------------------------------------------------------------- 65*cdf0e10cSrcweir /** reads data from the map. 66*cdf0e10cSrcweir 67*cdf0e10cSrcweir @param aKey 68*cdf0e10cSrcweir The key string which should be searched for. 69*cdf0e10cSrcweir 70*cdf0e10cSrcweir @return 71*cdf0e10cSrcweir the value matching aKey. 72*cdf0e10cSrcweir 73*cdf0e10cSrcweir @throws com::sun::star::container::NoSuchElementException 74*cdf0e10cSrcweir if an element under aKey does not exist. 75*cdf0e10cSrcweir */ 76*cdf0e10cSrcweir any getValue( [in] string aKey ) 77*cdf0e10cSrcweir raises( com::sun::star::container::NoSuchElementException ); 78*cdf0e10cSrcweir 79*cdf0e10cSrcweir 80*cdf0e10cSrcweir //------------------------------------------------------------------------- 81*cdf0e10cSrcweir /** checks for element existence. 82*cdf0e10cSrcweir 83*cdf0e10cSrcweir @param aKey 84*cdf0e10cSrcweir The key string which should be searched for. 85*cdf0e10cSrcweir 86*cdf0e10cSrcweir @return 87*cdf0e10cSrcweir true if an element with key aKey exists. 88*cdf0e10cSrcweir */ 89*cdf0e10cSrcweir boolean hasValue( [in] string aKey ); 90*cdf0e10cSrcweir 91*cdf0e10cSrcweir 92*cdf0e10cSrcweir //------------------------------------------------------------------------- 93*cdf0e10cSrcweir /** writes data to the map. 94*cdf0e10cSrcweir 95*cdf0e10cSrcweir @param aKey 96*cdf0e10cSrcweir The key string which should be used to store the value. 97*cdf0e10cSrcweir 98*cdf0e10cSrcweir @param aValue 99*cdf0e10cSrcweir The value that should be stored. 100*cdf0e10cSrcweir 101*cdf0e10cSrcweir @throws com::sun::star::lang::IllegalArgumentException 102*cdf0e10cSrcweir if the element could not be inserted. 103*cdf0e10cSrcweir 104*cdf0e10cSrcweir @throws com::sun::star::container::ElementExistException 105*cdf0e10cSrcweir if there is already a value stored under the key aKey. 106*cdf0e10cSrcweir */ 107*cdf0e10cSrcweir void insertValue( [in] string aKey, [in] any aValue ) 108*cdf0e10cSrcweir raises( com::sun::star::lang::IllegalArgumentException, 109*cdf0e10cSrcweir com::sun::star::container::ElementExistException ); 110*cdf0e10cSrcweir 111*cdf0e10cSrcweir 112*cdf0e10cSrcweir //------------------------------------------------------------------------- 113*cdf0e10cSrcweir /** the number of elements in the map. 114*cdf0e10cSrcweir */ 115*cdf0e10cSrcweir [attribute, readonly] long Count; 116*cdf0e10cSrcweir 117*cdf0e10cSrcweir 118*cdf0e10cSrcweir //------------------------------------------------------------------------- 119*cdf0e10cSrcweir /** obtains the key of an element by index. 120*cdf0e10cSrcweir 121*cdf0e10cSrcweir @param nIndex 122*cdf0e10cSrcweir is the index of the element. 123*cdf0e10cSrcweir 124*cdf0e10cSrcweir @return 125*cdf0e10cSrcweir the key string matching the given index. 126*cdf0e10cSrcweir 127*cdf0e10cSrcweir @throws com::sun::star::lang::IndexOutOfBoundsException 128*cdf0e10cSrcweir if the specified index is greater than the number of 129*cdf0e10cSrcweir elements 130*cdf0e10cSrcweir */ 131*cdf0e10cSrcweir string getKeyByIndex( [in] long nIndex ) 132*cdf0e10cSrcweir raises( com::sun::star::lang::IndexOutOfBoundsException ); 133*cdf0e10cSrcweir 134*cdf0e10cSrcweir 135*cdf0e10cSrcweir //------------------------------------------------------------------------- 136*cdf0e10cSrcweir /** obtains the value of an element by index. 137*cdf0e10cSrcweir 138*cdf0e10cSrcweir @param nIndex 139*cdf0e10cSrcweir is the index of the key. 140*cdf0e10cSrcweir 141*cdf0e10cSrcweir @return 142*cdf0e10cSrcweir the value matching the given index. 143*cdf0e10cSrcweir 144*cdf0e10cSrcweir @throws com::sun::star::lang::IndexOutOfBoundsException 145*cdf0e10cSrcweir if the specified index is greater than the number of 146*cdf0e10cSrcweir elements 147*cdf0e10cSrcweir */ 148*cdf0e10cSrcweir any getValueByIndex( [in] long nIndex ) 149*cdf0e10cSrcweir raises( com::sun::star::lang::IndexOutOfBoundsException ); 150*cdf0e10cSrcweir}; 151*cdf0e10cSrcweir 152*cdf0e10cSrcweir}; }; }; }; 153*cdf0e10cSrcweir 154*cdf0e10cSrcweir#endif 155