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
  20
  21 module com {  module sun {  module star {  module container {
  22
  23
  24 /** provides access to the elements of a collection through a unique identifier.
  25  */
  26 published interface XIdentifierAccess: com::sun::star::container::XElementAccess
  27 {
  28     /** @returns
  29             the element with the specified identifier
  30
  31         @param Identifier
  32             specifies the identifier of the element that should be retrieved.
  33
  34         @throws com::sun::star::lang::NoSuchElementException
  35             If the identifier is not existing.
  36
  37         @throws  com::sun::star::lang::WrappedTargetException
  38             If the implementation has internal reasons for exceptions,
  39             then wrap these in a com::sun::star::lang::WrappedTargetException
  40             exception.
  41      */
  42     any getByIdentifier( [in] long Identifier )
  43             raises( com::sun::star::container::NoSuchElementException,
  44                     com::sun::star::lang::WrappedTargetException );
  45
  46     // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  47     /** @returns
  48             a sequence of all identifiers in this container.
  49
  50         <p>The order of the identifiers is not specified. </p>
  51      */
  52     sequence<long> getIdentifiers();
  53 }
  54 ;
  55
  56
  57 }; }; }; };
  58
  59 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */