udkapi/com/sun/star/container/XIdentifierAccess.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XIdentifierAccess.idl,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_container_XIdentifierAccess_idl__
  31 #define __com_sun_star_container_XIdentifierAccess_idl__
  32
  33 #ifndef __com_sun_star_container_XElementAccess_idl__
  34 #include <com/sun/star/container/XElementAccess.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_container_NoSuchElementException_idl__
  38 #include <com/sun/star/container/NoSuchElementException.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_lang_WrappedTargetException_idl__
  42 #include <com/sun/star/lang/WrappedTargetException.idl>
  43 #endif
  44
  45 //=============================================================================
  46
  47 module com {  module sun {  module star {  module container {
  48
  49 //=============================================================================
  50
  51 /** provides access to the elements of a collection through a unique identifier.
  52  */
  53 published interface XIdentifierAccess: com::sun::star::container::XElementAccess
  54 {
  55     /** @returns
  56             the element with the specified identifier
  57
  58         @param Identifier
  59             specifies the identifier of the element that should be retrieved.
  60
  61         @throws com::sun::star::lang::NoSuchElementException
  62             If the identifier is not existing.
  63
  64         @throws  com::sun::star::lang::WrappedTargetException
  65             If the implementation has internal reasons for exceptions,
  66             then wrap these in a <typee scope="com::sun::star::lang">WrappedTargetException</type>
  67             exception.
  68      */
  69     any getByIdentifier( [in] long Identifierr )
  70             raises( com::sun::star::container::NoSuchElementException,
  71                     com::sun::star::lang::WrappedTargetException );
  72
  73     // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  74     /** @returns
  75             a sequence of all identifiers in this container.
  76
  77         <p>The order of the identifiers is not specified. </p>
  78      */
  79     sequence<long> getIdentifiers();
  80 }
  81 ;
  82
  83 //=============================================================================
  84
  85 }; }; }; };
  86
  87 #endif