Overview | Module | Use | Devguide | Index

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

:: com :: sun :: star :: configuration :: backend ::
interface XBackendEntities
  Base Hierarchy
      ::com::sun::star::uno::XInterface
       |
       +-XBackendEntities
Description Provides functionality relating to common and supported entities for a configuration data backend. See also XBackend See also XMultiLayerStratum Since version OpenOffice.org 1.1.1

Methods' Summary
getOwnerEntity | provides the entity id of the owner entity of the backend.
getAdminEntity | provides the entity id of an entity for general administrative access.
supportsEntity | determines, if a given entity id exists in this backend.
isEqualEntity | determines, if two given entity ids denote the same entity.

Methods' Details
getOwnerEntity
string getOwnerEntity(); |  |
Description provides the entity id of the owner entity of the backend. Returns an entity identifier for the owner entity. The owner entity is the default entity for the backend. For normal configuration data access the owner entity should always be used. See also XBackend::listOwnLayers() See also XBackend::getOwnUpdateHandler()
getAdminEntity
string getAdminEntity(); |  |
Description provides the entity id of an entity for general administrative access. The admin entity is an entity that should be used to read and manage configuration data that applies to all entities within the backend. Returns an entity identifier for the admin entity or an empty string, if there is no entity that can be used for general administrative access.
supportsEntity
boolean supportsEntity( | [in] string raises( | aEntity ) BackendAccessException );
Description determines, if a given entity id exists in this backend. Parameter aEntity The name of an entity. Throws com::sun::star::configuration::backend::BackendAccessException if an error occurs while accessing the backend. Returns true , if aEntity is a valid, existing entity for this backend, false otherwise.
isEqualEntity
boolean isEqualEntity( | [in] string [in] string raises( | aEntity, aOtherEntity ) BackendAccessException, ::com::sun::star::lang::IllegalArgumentException );
Description determines, if two given entity ids denote the same entity. Parameter aEntity The name of an entity. Parameter aOtherEntity The name of another entity. Returns true , if aEntity and aOtherEntity denote the same entity within this backend, false otherwise. Throws com::sun::star::configuration::backend::BackendAccessException if an error occurs while accessing the backend. Throws com::sun::star::lang::IllegalArgumentException if either entity does not exist.

Top of Page

Copyright © 2003 Sun Microsystems, Inc.