summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/xsd/XDataType.idl
blob: 46860ce0265a5d6e761883e4a7e0beb93ddb40bb (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
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: XDataType.idl,v $
 * $Revision: 1.4 $
 *
 * 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_XDataType_idl__
#define __com_sun_star_xsd_XDataType_idl__

#ifndef __com_sun_star_container_XNamed_idl__
#include <com/sun/star/container/XNamed.idl>
#endif
#ifndef __com_sun_star_util_VetoException_idl__
#include <com/sun/star/util/VetoException.idl>
#endif
#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif
#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif

//=============================================================================
module com {  module sun {  module star {  module xsd {

//-----------------------------------------------------------------------------
/** specifies an <a href="http://www.w3.org/TR/xmlschema-2/#built-in-datatypes">XSD compliant simple data type</a>
*/
interface XDataType
{
    /** provides generic access to the instance properties
    */
    interface com::sun::star::beans::XPropertySet;

    /** provides access to the name of the type
    */
    [attribute] string Name
    {
        set raises ( com::sun::star::util::VetoException );
    };

    /** specifies the pattern which strings conforming to this type comply to

        <p>See <a href="http://www.w3.org/TR/xmlschema-2/#rf-pattern">http://www.w3.org/TR/xmlschema-2/#rf-pattern</a></p>
    */
    [attribute] string Pattern;

    /** specifies how strings of this data type are to be processed, with respect to
        white spaces

        <p>See <a href="http://www.w3.org/TR/xmlschema-2/#rf-whiteSpace">http://www.w3.org/TR/xmlschema-2/#rf-whiteSpace</a></p>
    */
    [attribute] short WhiteSpaceTreatment
    {
        set raises ( com::sun::star::lang::IllegalArgumentException );
    };

    /** specifies whether the type is a basic type

        <p>Basic types are built into the type system, and cannot be changed by the user.</p>
    */
    [attribute, readonly] boolean IsBasic;

    /** class of the type

        @see DataTypeClass
    */
    [attribute, readonly] short TypeClass;

    /// TODO
    boolean validate( [in] string value );

    /// TODO
    string  explainInvalid( [in] string value );
};

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

}; }; }; };

#endif