/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XHierarchicalPropertySetInfo.idl,v $
 *
 *  $Revision: 1.13 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-09 14:52:03 $
 *
 *  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_beans_XHierarchicalPropertySetInfo_idl__
#define __com_sun_star_beans_XHierarchicalPropertySetInfo_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_beans_Property_idl__
#include <com/sun/star/beans/Property.idl>
#endif

#ifndef __com_sun_star_beans_UnknownPropertyException_idl__
#include <com/sun/star/beans/UnknownPropertyException.idl>
#endif

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


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

module com {  module sun {  module star {  module beans {

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

/** specifies a hierarchy of properties.

    <p>The specification only describes the properties, it does not contain
    any values.</p>
 */
published interface XHierarchicalPropertySetInfo: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    /** @returns
                the property with the specified name from the hierarchy.

        @param aHierarchicalName
                specifies the nested name of the property.

        @throws UnknownPropertyException
                if the property does not exist.

        @throws com::sun::star::lang::IllegalArgumentException
                if <var>aHierarchicalName</var> is not a well-formed
                nested name for this hierarchy.
                   An implementation is not required to detect this
                condition.

     */
    com::sun::star::beans::Property getPropertyByHierarchicalName( [in] string aHierarchicalName )
            raises( com::sun::star::beans::UnknownPropertyException );

    //-------------------------------------------------------------------------

    /** @returns
                <TRUE/> if a property with the specified name exists;
                otherwise <FALSE/> is returned.

        @param  aHierarchicalName
                specifies the name of the property.

        @throws com::sun::star::lang::IllegalArgumentException
                if <var>aHierarchicalName</var> is not a well-formed
                nested name for this hierarchy.
                   An implementation is not required to detect this
                condition.
     */
    boolean hasPropertyByHierarchicalName( [in] string aHierarchicalName );

};

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

}; }; }; };

#endif
