Top   Module   Use   Manual   Index 
 EXPORTING SERVICES | METHODS' SUMMARY | METHODS' DETAILS 

com :: sun :: star :: container ::

interface XHierarchicalNameAccess

Base Interface
com::sun::star::uno::XInterface

Description
is used to have hierarchical access to elements within a container.

You address an object of a specific level in the hierarchy by giving its fully qualified name, e.g., "com::sun::star::uno::XInterface".

To implement inaccurate name access, support the XExactName interface.

See also
com::sun::star::beans::XExactName


Known Services which Export this Interface

com::sun::star::reflection::TypeDescriptionManager This service is the central manager supporting the XHierarchicalNameAccessy interface. At runtime there will only be at most a single instance of the service. A manager instance is hooked into the C UNO runtime typelib and lives until the service manager is shut down.
You can manually add a provider by inserting it via the XSet interface.
com::sun::star::reflection::TypeDescriptionProvider A provider service supports the XHierarchicalNameAccess interface to read type descriptions and constants from a specific source, e.g., a typelib registry file.
com::sun::star::reflection::TypeDescriptionManager This service is the central manager supporting the XHierarchicalNameAccessy interface. At runtime there will only be at most a single instance of the service. A manager instance is hooked into the C UNO runtime typelib and lives until the service manager is shut down.
You can manually add a provider by inserting it via the XSet interface.
com::sun::star::reflection::TypeDescriptionProvider A provider service supports the XHierarchicalNameAccess interface to read type descriptions and constants from a specific source, e.g., a typelib registry file.
com::sun::star::ucb::HierarchyDataReadAccess provides read access to a fragment of the hierarchy data.
com::sun::star::configuration::HierarchyAccess provides access to a (by name) hierarchy of descendant elements.
com::sun::star::packages::Package The Package is a service that provides access to a set of files and folders contained within a Package. One instance of the Package service exists for each Package file to be manipulated. Each instance is created with an argument which specifies the URL of the Package file to which the user requires access. If the instance is created without arguments, it must be initialised with the XInitialization service methods before it is a valid instance of the service.

Methods' Summary

getByHierarchicalName
hasByHierarchicalName

Methods' Details

getByHierarchicalName
 
any
getByHierarchicalName(
[ in ] string aName )
raises ( com::sun::star::container::NoSuchElementException );

Returns
the object with the specified name.
Parameter aName
the name of the object.
Throws
NoSuchElementException if an element under Name does not exist.
hasByHierarchicalName
 
boolean
hasByHierarchicalName(
[ in ] string aName );

Returns
true if an element with this name is in the container, false otherwise.

In many cases, the next call is XNameAccess::getByName . You should optimize this case.

Parameter aName
the name of the object.

Top of Page