LibreOffice: com/sun/star/sdb/tools/XTableName.idl Source File

LibreOffice LibreOffice 7.3 SDK API Reference

XTableName.idl
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20#ifndef __com_sun_star_sdb_tools_XTableName_idl__
21#define __com_sun_star_sdb_tools_XTableName_idl__
22
23#include <com/sun/star/lang/IllegalArgumentException.idl>
24#include <com/sun/star/container/NoSuchElementException.idl>
25#include <com/sun/star/beans/XPropertySet.idl>
26
27module com { module sun { module star { module sdb { module tools {
28
56 interface XTableName
57{
60 [attribute] string CatalogName;
61
64 [attribute] string SchemaName;
65
69 [attribute] string TableName;
70
85 string getComposedName( [in] long Type, [in] boolean Quote )
86 raises ( com::sun::star::lang::IllegalArgumentException );
87
88
95 void setComposedName( [in] string ComposedName, [in] long Type );
96
106 [attribute, readonly] string NameForSelect;
107
123 [attribute] ::com::sun::star::beans::XPropertySet Table
124 {
125 get raises ( com::sun::star::container::NoSuchElementException );
126 set raises ( com::sun::star::lang::IllegalArgumentException );
127 };
128};
129
130}; }; }; }; };
131
132#endif
133
134/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
IllegalArgumentException.idl
NoSuchElementException.idl
XPropertySet.idl
com::sun::star::container::NoSuchElementException
is thrown by child access methods of collections, if the addressed child does not exist.
Definition: NoSuchElementException.idl:35
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:31
com::sun::star::beans::XPropertySet
provides information about and access to the properties from an implementation.
Definition: XPropertySet.idl:64
com::sun::star::sdb::tools::XTableName
allows to manipulate table names.
Definition: XTableName.idl:57
com::sun::star::sdb::tools::XTableName::setComposedName
void setComposedName([in] string ComposedName, [in] long Type)
sets a new composed table name
com::sun::star::sdb::tools::XTableName::CatalogName
string CatalogName
denotes the name of the catalog which the table is a part of
Definition: XTableName.idl:60
com::sun::star::sdb::tools::XTableName::getComposedName
string getComposedName([in] long Type, [in] boolean Quote)
returns the composed table name, including the catalog and schema name, respecting the database's quo...
com::sun::star::sdb::tools::XTableName::SchemaName
string SchemaName
denotes the name of the schema which the table is a part of
Definition: XTableName.idl:64
com::sun::star::sdb::tools::XTableName::TableName
string TableName
denotes the mere, unqualified table name, excluding any catalog and schema.
Definition: XTableName.idl:69
com::sun::star::sdb::tools::XTableName::NameForSelect
string NameForSelect
represents the table name in a form to be used in a SELECT statement.
Definition: XTableName.idl:106
com
Definition: Ambiguous.idl:22
com::sun::star::sdb::Table
extends the service com::sun::star::sdbcx::Table with additional display information,...
Definition: Table.idl:34