AOO410/main/offapi/com/sun/star/sdb/tools/CompositionType.idl

/**************************************************************
 * 
 * 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_sdb_tools_CompositionRule_idl__
#define __com_sun_star_sdb_tools_CompositionRule_idl__

//=============================================================================
module com {  module sun {  module star {  module sdb { module tools {
//=============================================================================

/** specifies which composition should be used when composing a table
    name.

    @see XTableName

    @since OpenOffice 2.0.4
*/
constants CompositionType
{
    /** specifies composition of a name to be used in table definitions

        @see XDatabaseMetaData::supportsCatalogsInTableDefinitions
        @see XDatabaseMetaData::supportsSchemasInTableDefinitions
    */
    const   long    ForTableDefinitions      = 0;

    /** specifies composition of a name to be used in index definitions

        @see XDatabaseMetaData::supportsCatalogsInIndexDefinitions
        @see XDatabaseMetaData::supportsSchemasInIndexDefinitions
    */
    const   long    ForIndexDefinitions      = 1;

    /** specifies composition of a name to be used in data manipulation

        @see XDatabaseMetaData::supportsCatalogsInDataManipulation
        @see XDatabaseMetaData::supportsSchemasInDataManipulation
    */
    const   long    ForDataManipulation      = 2;

    /** specifies composition of a name to be used in procedure calls

        @see XDatabaseMetaData::supportsCatalogsInProcedureCalls
        @see XDatabaseMetaData::supportsSchemasInProcedureCalls
    */
    const   long    ForProcedureCalls        = 3;

    /** specifies composition of a name to be used in privilege definitions

        @see XDatabaseMetaData::supportsCatalogsInPrivilegeDefinitions
        @see XDatabaseMetaData::supportsSchemasInPrivilegeDefinitions
    */
    const   long    ForPrivilegeDefinitions  = 4;

    /** specifies complete composition of a table name, including catalog and schema (if present),
        disregarding any database support for catalog and schema in any particular statements
    */
    const   long    Complete                 = 5;
};
    
//=============================================================================
}; }; }; }; };
//=============================================================================

#endif