/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XCommandInfo.idl,v $
 *
 *  $Revision: 1.7 $
 *
 *  last change: $Author: rt $ $Date: 2005/09/08 08:00:47 $
 *
 *  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_ucb_XCommandInfo_idl__
#define __com_sun_star_ucb_XCommandInfo_idl__

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

#ifndef __com_sun_star_ucb_CommandInfo_idl__
#include <com/sun/star/ucb/CommandInfo.idl>
#endif

#ifndef __com_sun_star_ucb_UnsupportedCommandException_idl__
#include <com/sun/star/ucb/UnsupportedCommandException.idl>
#endif


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

module com { module sun { module star { module ucb {

//=============================================================================
/** provides access to information on a set of commands.

	@version  1.0
	@author   Kai Sommerfeld
*/
published interface XCommandInfo: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------
	/** obtains information for all supported commands.

		@returns
		a sequence with information for all supported commands.
	*/
	sequence<com::sun::star::ucb::CommandInfo> getCommands();

	//-------------------------------------------------------------------------
	/** returns information for a specific command.

		@returns
		the information for the requested command.

		@param Name
		specifies the name of the requested command.

		@throws UnsupportedCommandException
		if the command is not supported.
	*/
	com::sun::star::ucb::CommandInfo getCommandInfoByName( [in] string Name )
			raises( com::sun::star::ucb::UnsupportedCommandException );

	//-------------------------------------------------------------------------
	/** returns information for a specific command.

		@returns
		the information for the requested command.

		@param Handle
		specifies the handle of the requested command.

		@throws UnsupportedCommandException
		if the command is not supported.
	*/
	com::sun::star::ucb::CommandInfo getCommandInfoByHandle( [in] long Handle )
			raises( com::sun::star::ucb::UnsupportedCommandException );

	//-------------------------------------------------------------------------
	/** checks whether a command specific is supported.

		@returns
		<TRUE/> if a command with the specified name is supported;
		otherwise <FALSE/> is returned.

		@param Name
		specifies the name of the requested command.
	*/
	boolean hasCommandByName( [in] string Name );

	//-------------------------------------------------------------------------
	/** checks whether a apecific command is supported.

		@returns
		<TRUE/> if a command with the specified handle is supported;
		otherwise <FALSE/> is returned.

		@param Name
		specifies the handle of the requested command.
	*/
	boolean hasCommandByHandle( [in] long Handle );

};

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

}; }; }; };

#endif
