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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_container_XIdentifierAccess_idl__
  20 #define __com_sun_star_container_XIdentifierAccess_idl__
  21
  22 #include <com/sun/star/container/XElementAccess.idl>
  23
  24 #include <com/sun/star/container/NoSuchElementException.idl>
  25
  26 #include <com/sun/star/lang/WrappedTargetException.idl>
  27
  28
  29 module com {  module sun {  module star {  module container {
  30
  31
  32 /** provides access to the elements of a collection through a unique identifier.
  33  */
  34 published interface XIdentifierAccess: com::sun::star::container::XElementAccess
  35 {
  36     /** @returns
  37             the element with the specified identifier
  38
  39         @param Identifier
  40             specifies the identifier of the element that should be retrieved.
  41
  42         @throws com::sun::star::lang::NoSuchElementException
  43             If the identifier is not existing.
  44
  45         @throws  com::sun::star::lang::WrappedTargetException
  46             If the implementation has internal reasons for exceptions,
  47             then wrap these in a com::sun::star::lang::WrappedTargetException
  48             exception.
  49      */
  50     any getByIdentifier( [in] long Identifier )
  51             raises( com::sun::star::container::NoSuchElementException,
  52                     com::sun::star::lang::WrappedTargetException );
  53
  54     // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  55     /** @returns
  56             a sequence of all identifiers in this container.
  57
  58         <p>The order of the identifiers is not specified. </p>
  59      */
  60     sequence<long> getIdentifiers();
  61 }
  62 ;
  63
  64
  65 }; }; }; };
  66
  67 #endif
  68
  69 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */