/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_beans_XPropertySetInfo_idl__
#define __com_sun_star_beans_XPropertySetInfo_idl__

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

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

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


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

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

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

/** specifies a set of properties.

    <p>There are three kinds of properties:
    <ul>
        <li>bound properties</li>
        <li>constrained properties</li>
        <li>free properties</li>
    </ul>

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

    /** @returns
            a sequence with all property descriptors which are specified
            within this <type>XPropertySetInfo</type>.
     */
    sequence<com::sun::star::beans::Property> getProperties();

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

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

        @param aName
            specifies the name of the property.

        @throws UnknownPropertyException
            if the property does not exist.
     */
    com::sun::star::beans::Property getPropertyByName( [in] string aName )
            raises( com::sun::star::beans::UnknownPropertyException );

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

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

        @param aName
            specifies the name of the property.
     */
    boolean hasPropertyByName( [in] string Name );

};

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

}; }; }; };

#endif

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