Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous

Overview Module Use Devguide Index
Methods' Summary Attributes' Summary Methods' Details Attributes' Details

:: com :: sun :: star :: configuration :: backend ::

interface XSchema
Description
Handles access to the elements of a component schema, i.e its templates and its component definition.
Since
OOo 1.1.2
Methods' Summary
readSchema Describes the full schema (templates + component) to a XSchemaHandler.  
readComponent Describes only the component definition to a XSchemaHandler.  
readTemplates Describes the component templates to a XSchemaHandler.  
Methods' Details
readSchema
void
readSchema( [in] XSchemaHandler  aHandler )
raises( ::com::sun::star::lang::NullPointerException,
::com::sun::star::lang::WrappedTargetException,
MalformedDataException );
Description
Describes the full schema (templates + component) to a XSchemaHandler.
Parameter aHandler
schema handler that will receive calls describing the contents of the templates and the component definition
Throws
com::sun::star::lang::NullPointerException if a NULL handler is passed.
Throws
com::sun::star::lang::WrappedTargetException if an error occurs in the access to or processing of the data or if a subsequent call to any of the XSchemamethods is made. The elements of a component schema are only parsed once,a repeat call leads to exception.
Throws
com::sun::star::configuration::backend::MalformedDataException if the data read from the layer is rejected as invalid by the XSchemaHandler.
readComponent
void
readComponent( [in] XSchemaHandler  aHandler )
raises( ::com::sun::star::lang::NullPointerException,
::com::sun::star::lang::WrappedTargetException,
MalformedDataException );
Description
Describes only the component definition to a XSchemaHandler.
Parameter aHandler
schema handler that will receive calls describing the contents of the component definition
Throws
com::sun::star::lang::NullPointerException if a NULL handler is passed.
Throws
com::sun::star::lang::WrappedTargetException if an error occurs in the access to or processing of the data or if a subsequent call to any of the XSchemamethods is made. The elements of a component schema are only parsed once,a repeat call leads to exception.
Throws
com::sun::star::configuration::backend::MalformedDataException if the data read from the layer is rejected as invalid by the XSchemaHandler.
readTemplates
void
readTemplates( [in] XSchemaHandler  aHandler )
raises( ::com::sun::star::lang::NullPointerException,
::com::sun::star::lang::WrappedTargetException,
MalformedDataException );
Description
Describes the component templates to a XSchemaHandler.
Parameter aHandler
schema handler that will receive calls describing the contents of the templates
Throws
com::sun::star::lang::NullPointerException if a NULL handler is passed.
Throws
com::sun::star::lang::WrappedTargetException if an error occurs in the access to or processing of the data or if a subsequent call to any of the XSchemamethods is made. The elements of a component schema are only parsed once,a repeat call leads to exception.
Throws
com::sun::star::configuration::backend::MalformedDataException if the data read from the layer is rejected as invalid by the XSchemaHandler.
Top of Page

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.