/*************************************************************************
 *
 *  $RCSfile: DataPilotSourceDimension.idl,v $
 *
 *  $Revision: 1.5.22.2 $
 *
 *  last change: $Author: mi $ $Date: 2003/01/21 17:47:55 $
 *
 *  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_sheet_DataPilotSourceDimension_idl__
#define __com_sun_star_sheet_DataPilotSourceDimension_idl__

#ifndef __com_sun_star_container_XNamed_idl__
#include <com/sun/star/container/XNamed.idl>
#endif

#ifndef __com_sun_star_sheet_XHierarchiesSupplier_idl__
#include <com/sun/star/sheet/XHierarchiesSupplier.idl>
#endif

#ifndef __com_sun_star_util_XCloneable_idl__
#include <com/sun/star/util/XCloneable.idl>
#endif

#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif

#ifndef __com_sun_star_sheet_DataPilotFieldOrientation_idl__
#include <com/sun/star/sheet/DataPilotFieldOrientation.idl>
#endif

#ifndef __com_sun_star_sheet_GeneralFunction_idl__
#include <com/sun/star/sheet/GeneralFunction.idl>
#endif

#ifndef __com_sun_star_sheet_TableFilterField_idl__
#include <com/sun/star/sheet/TableFilterField.idl>
#endif

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

 module com {  module sun {  module star {  module sheet {

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

/** represents a dimension in a data pilot source.

	<p>A dimension is equivalent to a column of a cell range in a spreadsheet
	used for a data pilot field.</p>

	<p>In more complex data sources, a dimension may contain several
	hierarchies, which consolidate items of a complex data type, called
	levels.</p>

	<p>Example: In a database, a column contains date values. This column
	will be a dimension of the data pilot source. One hierarchy may contain
	the 3 levels year, month, day. Another hierarchy may contain the 2 levels
	year and week number.</p>

	@see com::sun::star::sheet::DataPilotSource
	@see com::sun::star::sheet::DataPilotTable
 */
service DataPilotSourceDimension
{
	//-------------------------------------------------------------------------

	/** provides access to the name of the dimension, i.e. used in
		collections.
	 */
	interface com::sun::star::container::XNamed;

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

	/** provides access to the collection of hierarchies of this dimension.
	 */
	interface com::sun::star::sheet::XHierarchiesSupplier;

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

	/** supports duplicating the dimension.

		<p>A dimension may be used several times in a data pilot table,
		i.e. as row field and data field.</p>
	 */
	interface com::sun::star::util::XCloneable;

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

//! service PropertySet
	/** provides access to the properties.
	 */
	interface com::sun::star::beans::XPropertySet;

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

	/** returns the name of the dimension from which this dimension was
		cloned, or <NULL/> if it was not cloned.
	 */
	[readonly, property] com::sun::star::container::XNamed Original;

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

	/** contains <TRUE/> if this is the dimension used to layout the
		different data dimensions.
	 */
	[readonly, property] boolean IsDataLayoutDimension;

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

	/** specifies where the dimension is used.
	 */
	[property] com::sun::star::sheet::DataPilotFieldOrientation Orientation;

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

	/** specifies the position of the dimension within its orientation.
	 */
	[property] long Position;

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

	/** specifies how data are aggregated.
	 */
	[property] com::sun::star::sheet::GeneralFunction Function;

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

	/** specifies which hierarchy of the dimension is used.

		@see com::sun::star::sheet::DataPilotSourceHierarchies
	 */
	[property] long UsedHierarchy;

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

	/** specifies which values are used.
	 */
	[property] sequence< com::sun::star::sheet::TableFilterField > Filter;

};

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

}; }; }; };

#endif

