/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_container_XIdentifierContainer_idl__
#define __com_sun_star_container_XIdentifierContainer_idl__

#include <com/sun/star/container/XIdentifierReplace.idl>

#include <com/sun/star/lang/IllegalArgumentException.idl>

#include <com/sun/star/container/ElementExistException.idl>

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

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


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


/** This is the generic interface for supporting the creation and removal of
    elements with unique identifiers.

    @see XContainer
 */
published interface XIdentifierContainer: com::sun::star::container::XIdentifierReplace
{

    /** inserts an element and creates a new unique identifier for it.

        @returns
            the newly created identifier under which the element is inserted.

        @param aElement
            The new element that will be inserted.

        @throws com::sun::star::lang::IllegalArgumentException
            if the argument is not vailid for this container.

        @throws  com::sun::star::lang::WrappedTargetException
            If the implementation has internal reasons for exceptions,
            then wrap these in a <type scope="com::sun::star::lang">WrappedTargetException</type>
            exception.

     */
    long insert( [in] any aElement )
            raises( com::sun::star::lang::IllegalArgumentException,
                    com::sun::star::lang::WrappedTargetException );


    /** removes the element with the specified identifier.

        @param Identifier
            The identifier that should be removed.

        @throws com::sun::star::lang::NoSuchElementException
            If the identifier does not exist.

        @throws  com::sun::star::lang::WrappedTargetException
            If the implementation has internal reasons for exceptions,
            then wrap these in a <type scope="com::sun::star::lang">WrappedTargetException</type>
            exception.
     */
    void removeByIdentifier( [in] long Identifier )
            raises( com::sun::star::container::NoSuchElementException,
                    com::sun::star::lang::WrappedTargetException );

};


}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */