Overview | Module | Use | Devguide | Index

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

:: com :: sun :: star :: script ::
interface XLibraryContainer
  Base Hierarchy
      ::com::sun::star::uno::XInterface
       |
       +-::com::sun::star::container::XElementAccess
          |
          +-::com::sun::star::container::XNameAccess
             |
             +-XLibraryContainer
Description Provides access to a library system.

Methods' Summary
createLibrary | Creates a new library
createLibraryLink | Creates a link to an "external" library that then can be accessed using this library manager. The format of the StorageURL is a matter of the implementation. If the read only flag is set, the linked library cannot be modified. In this case, the returned interface really is only an XNameAccess. If ReadOnly is false (and the referenced storage allows write access) the returned interface also can be a ::com::sun::star::container::XNameContainer .
removeLibrary | removes the library item with the specified name. If the accessed library item is a link only the link is removed, not the target library.
isLibraryLoaded | returns true if the accessed library is already loaded from the storage, otherwise false.
loadLibrary | Causes the accessed library to be loaded from its storage if it hasn't already been loaded.

Methods' Details
createLibrary
::com::sun::star::container::XNameContainer createLibrary( | [in] string raises( | Name ) ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::container::ElementExistException );
Description Creates a new library
createLibraryLink
::com::sun::star::container::XNameAccess createLibraryLink( | [in] string [in] string [in] boolean raises( | Name, StorageURL, ReadOnly ) ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::container::ElementExistException );
Description Creates a link to an "external" library that then can be accessed using this library manager. The format of the StorageURL is a matter of the implementation. If the read only flag is set, the linked library cannot be modified. In this case, the returned interface really is only an XNameAccess. If ReadOnly is false (and the referenced storage allows write access) the returned interface also can be a ::com::sun::star::container::XNameContainer .
removeLibrary
void removeLibrary( | [in] string raises( | Name ) ::com::sun::star::container::NoSuchElementException, ::com::sun::star::lang::WrappedTargetException );
Description removes the library item with the specified name. If the accessed library item is a link only the link is removed, not the target library.
isLibraryLoaded
boolean isLibraryLoaded( | [in] string raises( | Name ) ::com::sun::star::container::NoSuchElementException );
Description returns true if the accessed library is already loaded from the storage, otherwise false.
loadLibrary
void loadLibrary( | [in] string raises( | Name ) ::com::sun::star::container::NoSuchElementException, ::com::sun::star::lang::WrappedTargetException );
Description Causes the accessed library to be loaded from its storage if it hasn't already been loaded.

Top of Page

Copyright © 2003 Sun Microsystems, Inc.