Overview | Module | Use | Devguide | Index

Methods' Summary | Methods' Details | Attributes' Summary | Attributes' Details

:: com :: sun :: star :: configuration :: backend ::
interface XCompositeLayer
  Base Hierarchy
      ::com::sun::star::uno::XInterface
       |
       +-XLayer
          |
          +-XCompositeLayer
Description provides read access to layers that contain sublayers accessible through an additional criterion (for instance the locale they contain data for). Since version OpenOffice.org 1.1.1

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 [in] string raises( | aHandler, aSubLayerId ) ::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

Copyright © 2003 Sun Microsystems, Inc.