AOO410/main/offapi/com/sun/star/xsd/XDataType.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_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