146 lines
5.3 KiB
Plaintext
146 lines
5.3 KiB
Plaintext
/*************************************************************************
|
|
*
|
|
* $RCSfile: XIdentifierContainer.idl,v $
|
|
*
|
|
* $Revision: 1.6 $
|
|
*
|
|
* last change: $Author: obo $ $Date: 2004-06-03 15:38:51 $
|
|
*
|
|
* The Contents of this file are made available subject to the terms of
|
|
* either of the following licenses
|
|
*
|
|
* - GNU Lesser General Public License Version 2.1
|
|
* - Sun Industry Standards Source License Version 1.1
|
|
*
|
|
* Sun Microsystems Inc., October, 2000
|
|
*
|
|
* GNU Lesser General Public License Version 2.1
|
|
* =============================================
|
|
* Copyright 2000 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
|
|
*
|
|
*
|
|
* Sun Industry Standards Source License Version 1.1
|
|
* =================================================
|
|
* The contents of this file are subject to the Sun Industry Standards
|
|
* Source License Version 1.1 (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.openoffice.org/license.html.
|
|
*
|
|
* Software provided under this License is provided on an "AS IS" basis,
|
|
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
|
|
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
|
|
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
|
|
* See the License for the specific provisions governing your rights and
|
|
* obligations concerning the Software.
|
|
*
|
|
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
|
|
*
|
|
* Copyright: 2000 by Sun Microsystems, Inc.
|
|
*
|
|
* All Rights Reserved.
|
|
*
|
|
* Contributor(s): _______________________________________
|
|
*
|
|
*
|
|
************************************************************************/
|
|
#ifndef __com_sun_star_container_XIdentifierContainer_idl__
|
|
#define __com_sun_star_container_XIdentifierContainer_idl__
|
|
|
|
#ifndef __com_sun_star_container_XIdentifierReplace_idl__
|
|
#include <com/sun/star/container/XIdentifierReplace.idl>
|
|
#endif
|
|
|
|
#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
|
|
#include <com/sun/star/lang/IllegalArgumentException.idl>
|
|
#endif
|
|
|
|
#ifndef __com_sun_star_container_ElementExistException_idl__
|
|
#include <com/sun/star/container/ElementExistException.idl>
|
|
#endif
|
|
|
|
#ifndef __com_sun_star_lang_WrappedTargetException_idl__
|
|
#include <com/sun/star/lang/WrappedTargetException.idl>
|
|
#endif
|
|
|
|
#ifndef __com_sun_star_container_NoSuchElementException_idl__
|
|
#include <com/sun/star/container/NoSuchElementException.idl>
|
|
#endif
|
|
|
|
//=============================================================================
|
|
|
|
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
|