LibreOffice LibreOffice 25.8 SDK API Reference

XObjectNames.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
20module com { module sun { module star { module sdb { module tools {
21
51 interface XObjectNames
52{
79 string suggestName( [in] long CommandType, [in] string BaseName )
80 raises ( com::sun::star::lang::IllegalArgumentException,
81 com::sun::star::sdbc::SQLException );
82
91 string convertToSQLName( [in] string Name );
92
120 boolean isNameUsed( [in] long CommandType, [in] string Name )
121 raises ( com::sun::star::lang::IllegalArgumentException,
122 com::sun::star::sdbc::SQLException );
123
134 boolean isNameValid( [in] long CommandType, [in] string Name )
135 raises ( com::sun::star::lang::IllegalArgumentException );
136
150 void checkNameForCreate( [in] long CommandType, [in] string Name )
151 raises ( com::sun::star::sdbc::SQLException );
152};
153
154}; }; }; }; };
155
156/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:27
com::sun::star::sdbc::SQLException
is an exception that provides information on a database access error.
Definition: SQLException.idl:41
com::sun::star::sdb::tools::XObjectNames
encapsulates functionality which you might find useful when writing a database application which deal...
Definition: XObjectNames.idl:52
com::sun::star::sdb::tools::XObjectNames::isNameUsed
boolean isNameUsed([in] long CommandType, [in] string Name)
checks whether a given name is used as table respectively query name in the database.
com::sun::star::sdb::tools::XObjectNames::suggestName
string suggestName([in] long CommandType, [in] string BaseName)
suggests a (unique) table or query name
com::sun::star::sdb::tools::XObjectNames::isNameValid
boolean isNameValid([in] long CommandType, [in] string Name)
checks whether a given name is valid as table or query name
com::sun::star::sdb::tools::XObjectNames::convertToSQLName
string convertToSQLName([in] string Name)
converts the given object name to a name which is valid in the database.
com::sun::star::sdb::tools::XObjectNames::checkNameForCreate
void checkNameForCreate([in] long CommandType, [in] string Name)
checks whether a given name is allowed for a to-be-created table or query in the database.
com
Definition: Ambiguous.idl:20