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

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