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 XLayerImporter
Description
allows importing a layer into a Backend
Since
OOo 1.1.2
Methods' Summary
getTargetBackend gets the target backend for importing.  
setTargetBackend sets the target backend for importing.  
importLayer Imports the layer given into the backend.  
importLayerForEntity Imports the layer given into the backend for a given entity.  
Methods' Details
getTargetBackend
XBackend
getTargetBackend();
Description
gets the target backend for importing.
Returns
the Backend into which layers are imported by
setTargetBackend
void
setTargetBackend( [in] XBackend  aBackend )
raises( ::com::sun::star::lang::NullPointerException );
Description
sets the target backend for importing.
Parameter aBackend
a Backend into which layers should be imported by XLayerImporter::importLayer().
Throws
com::sun::star::lang::NullPointerException if the backend passed is NULL.
importLayer
void
importLayer( [in] XLayer  aLayer )
raises( MalformedDataException,
::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::lang::NullPointerException,
::com::sun::star::lang::WrappedTargetException );
Description
Imports the layer given into the backend.

This method imports data for the current entity of the backend.

Parameter aLayer
a layer whose data will be imported into the backend
Throws
com::sun::star::lang::NullPointerException if the layer passed is NULL or no backend is available.
Throws
com::sun::star::configuration::backend::MalformedDataException if the layer passed is invalid
Throws
com::sun::star::lang::IllegalArgumentException if the layer passed is for a component that doesn't exist in the backend
Throws
com::sun::star::lang::WrappedTargetException if an error occurs in the backend or source layer.
See also
XBackend::getOwnUpdateHandler()
importLayerForEntity
void
importLayerForEntity( [in] XLayer  aLayer,
[in] string  aEntity )
raises( MalformedDataException,
::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::lang::NullPointerException,
::com::sun::star::lang::WrappedTargetException );
Description
Imports the layer given into the backend for a given entity.

This method imports data for the current entity of the backend.

Parameter aLayer
a layer whose data will be imported into the backend
Parameter aEntity
a entity into whose data the layer will be imported
Throws
com::sun::star::lang::NullPointerException if the layer passed is NULL or no backend is available.
Throws
com::sun::star::configuration::backend::MalformedDataException if the layer passed is invalid
Throws
com::sun::star::lang::IllegalArgumentException if the layer passed is for a component that doesn't exist in the backend or if the entity doesn't exist in the backend.
Throws
com::sun::star::lang::WrappedTargetException if an error occurs in the backend or source layer.
See also
XBackend::getUpdateHandler()
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.