Interface XKeyAlteration

Devguide

Index

Methods' Summary

Attributes' Summary

Methods' Details

Attributes' Details

:: com :: sun :: star :: sdb :: tools ::

unpublished

interface XKeyAlteration

Base Interfaces

XKeyAlteration
┗ XConnectionSupplier
   ┗ ::com::sun::star::lang::XInitialization

XConnectionSupplier

(referenced interface's summary:): allows to access the active connection

Usage Restrictions: not published
Description: allows to alter the keys of a table.
Since: OOo 3.3
See also: ::com::sun::star::sdb::DataSource::Settings, ::com::sun::star::sdbcx::XAppend, ::com::sun::star::sdbcx::XDrop

Methods' Summary
dropKey	drops an object of the related container identified by its name.
addKey	creates a new object using the given descriptor and appends it to the related container. Note: The descriptor will not be changed and can be used again to append another object.

Methods' Details

dropKey

void
dropKey(	[in] ::com::sun::star::beans::XPropertySet	table,
	[in] ::com::sun::star::beans::XPropertySet	key )
raises(	::com::sun::star::sdbc::SQLException );

Description: drops an object of the related container identified by its name.
Parameter table: the table to be altered
Parameter key: the key to be dropped
Throws: com::sun::star::sdbc::SQLException if a database access error occurs.

addKey

void
addKey(	[in] ::com::sun::star::beans::XPropertySet	table,
	[in] ::com::sun::star::beans::XPropertySet	descriptor )
raises(	::com::sun::star::sdbc::SQLException );

Description: creates a new object using the given descriptor and appends it to the related container. Note: The descriptor will not be changed and can be used again to append another object.
Parameter table: the table to be altered
Parameter descriptor: the descriptor which should be serve to append a new object
Throws: com::sun::star::sdbc::SQLException if a database access error occurs.

Top of Page

Copyright © 2012, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.