Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


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

interface XCompositeLayer
Base Interfaces
XCompositeLayerXLayer

XLayer
(referenced interface's summary:)
provides read access to the data contained in a layer.
Description
provides read access to layers that contain sublayers accessible through an additional criterion (for instance the locale they contain data for).
Since
OOo 1.1.2

Methods' Summary
listSubLayerIds Returns a list of the criteria that can be used to access the sublayers.  
readSubLayerData Describes the content of a particular sublayer to an XLayerHandler.  
Methods' Details
listSubLayerIds
sequence< string >
listSubLayerIds()
raises( ::com::sun::star::lang::WrappedTargetException );

Description
Returns a list of the criteria that can be used to access the sublayers.
Returns
a list supported sublayer identifiers
Throws
com::sun::star::lang::WrappedTargetException if an error occurs in the retrieval of the data.
readSubLayerData
void
readSubLayerData( [in] XLayerHandler  aHandler,
[in] string  aSubLayerId )
raises( ::com::sun::star::lang::NullPointerException,
::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::lang::WrappedTargetException,
MalformedDataException );

Description
Describes the content of a particular sublayer to an XLayerHandler.
Parameter aHandler
Handler object that will receive calls describing the contents of the sublayer.
Parameter aSubLayerId
Identifier of the sublayer to be read.

Must be one the identifiers returned by XCompositeLayer::listSubLayerIds()

Throws
com::sun::star::lang::NullPointerException if a NULL handler is passed.
Throws
com::sun::star::lang::IllegalArgumentException if the identifier is invalid.
Throws
com::sun::star::lang::WrappedTargetException if an error occurs in the access to or processing of the data.
Throws
com::sun::star::configuration::backend::MalformedDataException if the data read from the layer is rejected as invalid by the XLayerHandler.
Top of Page

Apache Software Foundation

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

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