summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/xforms/XDataTypeRepository.idl
blob: b29f59328b80ae3c72cbb4e738037eaec622a4d5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_xsd_XDataTypeRepository_idl__
#define __com_sun_star_xsd_XDataTypeRepository_idl__

#include <com/sun/star/container/XEnumerationAccess.idl>
#include <com/sun/star/container/XNameAccess.idl>
#include <com/sun/star/xsd/XDataType.idl>
#include <com/sun/star/container/NoSuchElementException.idl>
#include <com/sun/star/container/ElementExistException.idl>
#include <com/sun/star/util/VetoException.idl>


//=============================================================================
module com {  module sun {  module star {  module xforms {

//-----------------------------------------------------------------------------
/** specifies a repository of XSD data types

    <p>The elements of the repository are instances supporting the <type scope="com::sun::star::xsd">XDataType</type>
    interface.</p>
*/
interface XDataTypeRepository
{
    /** provides access to an enumeration of the contained data types
    */
    interface com::sun::star::container::XEnumerationAccess;

    /** provides untyped access to the elements of the repository, as well as meta information
        such as the names of all contained types, and the existence of a named type
    */
    interface com::sun::star::container::XNameAccess;

    /** retrieves the basic type for the given type class

        @see com::sun::star::xsd::DataTypeClass

        @throws com::sun::star::container::NoSuchElementException
            if in the repository, there is no data type with the given class
    */
    com::sun::star::xsd::XDataType
        getBasicDataType( [in] short dataTypeClass )
            raises ( com::sun::star::container::NoSuchElementException );

    /** creates a clone of the given data type, and inserts it into the repository

        @throws com::sun::star::container::NoSuchElementException
            if the given name does not refer to a type in the repository

        @throws com::sun::star::container::ElementExistException
            if the new name is already used in the repository
    */
    com::sun::star::xsd::XDataType
        cloneDataType( [in] string sourceName, [in] string newName )
            raises( com::sun::star::container::NoSuchElementException, com::sun::star::container::ElementExistException );

    /** removes a data type given by name from the repository

        @throws com::sun::star::container::NoSuchElementException
            if the given name does not refer to a type in the repository

        @throws com::sun::star::util::VetoException
            if the specified data type is a built-in (basic) data type, and cannot
            be removed

        @see com::sun::star::xsd::XDataType
    */
    void
        revokeDataType( [in] string typeName )
            raises( com::sun::star::container::NoSuchElementException, com::sun::star::util::VetoException );

    /**
    */
    com::sun::star::xsd::XDataType
        getDataType( [in] string typeName )
            raises( com::sun::star::container::NoSuchElementException );
};

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

}; }; }; };

#endif