xref: /aoo4110/main/offapi/com/sun/star/xsd/XDataType.idl (revision b1cdbd2c)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_xsd_XDataType_idl__
25#define __com_sun_star_xsd_XDataType_idl__
26
27#ifndef __com_sun_star_container_XNamed_idl__
28#include <com/sun/star/container/XNamed.idl>
29#endif
30#ifndef __com_sun_star_util_VetoException_idl__
31#include <com/sun/star/util/VetoException.idl>
32#endif
33#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
34#include <com/sun/star/lang/IllegalArgumentException.idl>
35#endif
36#ifndef __com_sun_star_beans_XPropertySet_idl__
37#include <com/sun/star/beans/XPropertySet.idl>
38#endif
39
40//=============================================================================
41module com {  module sun {  module star {  module xsd {
42
43//-----------------------------------------------------------------------------
44/** specifies an <a href="http://www.w3.org/TR/xmlschema-2/#built-in-datatypes">XSD compliant simple data type</a>
45*/
46interface XDataType
47{
48    /** provides generic access to the instance properties
49    */
50    interface com::sun::star::beans::XPropertySet;
51
52    /** provides access to the name of the type
53    */
54    [attribute] string Name
55    {
56        set raises ( com::sun::star::util::VetoException );
57    };
58
59    /** specifies the pattern which strings conforming to this type comply to
60
61        <p>See <a href="http://www.w3.org/TR/xmlschema-2/#rf-pattern">http://www.w3.org/TR/xmlschema-2/#rf-pattern</a></p>
62    */
63    [attribute] string Pattern;
64
65    /** specifies how strings of this data type are to be processed, with respect to
66        white spaces
67
68        <p>See <a href="http://www.w3.org/TR/xmlschema-2/#rf-whiteSpace">http://www.w3.org/TR/xmlschema-2/#rf-whiteSpace</a></p>
69    */
70    [attribute] short WhiteSpaceTreatment
71    {
72        set raises ( com::sun::star::lang::IllegalArgumentException );
73    };
74
75    /** specifies whether the type is a basic type
76
77        <p>Basic types are built into the type system, and cannot be changed by the user.</p>
78    */
79    [attribute, readonly] boolean IsBasic;
80
81    /** class of the type
82
83        @see DataTypeClass
84    */
85    [attribute, readonly] short TypeClass;
86
87    /// TODO
88    boolean validate( [in] string value );
89
90    /// TODO
91    string  explainInvalid( [in] string value );
92};
93
94//=============================================================================
95
96}; }; }; };
97
98#endif
99