summaryrefslogtreecommitdiff
path: root/udkapi/com/sun/star/container/XImplicitIDContainer.idl
blob: b6141bc6007a83f9c5fbb05fd90ddcca3ed96791 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XImplicitIDContainer.idl,v $
 *
 *  $Revision: 1.6 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-09 15:17:15 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#ifndef __com_sun_star_container_XImplicitIDContainer_idl__
#define __com_sun_star_container_XImplicitIDContainer_idl__

#ifndef __com_sun_star_container_XImplicitIDReplace_idl__
#include <com/sun/star/container/XImplicitIDReplace.idl>
#endif

#ifndef __com_sun_star_container_NoSuchElementException_idl__
#include <com/sun/star/container/NoSuchElementException.idl>
#endif

#ifndef __com_sun_star_lang_WrappedTargetException_idl__
#include <com/sun/star/lang/WrappedTargetException.idl>
#endif


//=============================================================================

module com {  module sun {  module star {  module container {

/** makes it possible to insert and remove elements in/from a container
    using an implicit (unique) ID.
 */
published interface XImplicitIDContainer: com::sun::star::container::XImplicitIDReplace
{
    /** adds a new object to the container and generates an implicit (unique)
        ID for this object.

        @returns
            the implicit ID for the new object.
     */
    string addWithImplicitID( [in] any aElement );

    /** removes an object from the container which is specified by
        an implicit (unique) identifier.
     */
    void removeByImplicitID( [in] string ID )
        raises( com::sun::star::container::NoSuchElementException );
};

//=============================================================================

}; }; }; };

/*=============================================================================

=============================================================================*/
#endif