xref: /trunk/main/offapi/com/sun/star/sdbcx/KeyDescriptor.idl (revision d1766043)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_sdbcx_KeyDescriptor_idl__
#define __com_sun_star_sdbcx_KeyDescriptor_idl__

#ifndef __com_sun_star_sdbcx_Descriptor_idl__
#include <com/sun/star/sdbcx/Descriptor.idl>
#endif

module com { module sun { module star { module sdbcx {

 published interface XColumnsSupplier;

/**
 is used to define a new key for a table.

 @see com::sun::star::sdbcx::Key
 */
published service KeyDescriptor
{
	service Descriptor;

	/** access to the contained key columns.
	*/
	interface XColumnsSupplier;

	/** indicates the type of the key.
		@see com::sun::star::sdbcx::KeyType
	 */
	[property] long Type;

	/** is the name of the referenced table, only used for foreign keys.
	*/
	[property] string ReferencedTable;

	/** is the rule which is applied for updates; only used for foreign keys.
		@see com::sun::star::sdbc::KeyRule
	 */
	[property] long UpdateRule;

	/** is the rule which is applied for deletions; only used for foreign keys.
		@see com::sun::star::sdbc::KeyRule
	*/
	[property] long DeleteRule;
};

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

}; }; }; };

#endif