Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous


:: com :: sun :: star :: ucb ::

service HierarchyDataReadWriteAccess
Description
provides read and write access to a fragment of the hierarchy data.

Included Services - Summary
HierarchyDataReadAccess

provides read access to a fragment of the hierarchy data

Exported Interfaces - Summary
::com::sun::star::container::XNameContainer

allows adding and removing of hierarchy data nodes, replacing of the value of hierarchy data node members, as well as obtaining the value of hieryrchy data node members. (details)

::com::sun::star::lang::XSingleServiceFactory

gives access to all contents provided by this provider. (details)

::com::sun::star::util::XChangesBatch

allows managing changes within the hierarchy. (details)

Included Services - Details
HierarchyDataReadAccess
Description
provides read access to a fragment of the hierarchy data
Exported Interfaces - Details
::com::sun::star::container::XNameContainer
Description
allows adding and removing of hierarchy data nodes, replacing of the value of hierarchy data node members, as well as obtaining the value of hieryrchy data node members.

Adding and removing must only be supported if the access object points to the "Children" data member of a node or to the root node. It will insert a new node or or remove an existing one. If supported on data nodes, adding must add new data members to the node, removing must remove data members. However, the mandatory data members (Title, TargetURL, Children) must never be removable.

Replacing and getting values must be supported be every data node.

::com::sun::star::lang::XSingleServiceFactory
Description
gives access to all contents provided by this provider.

::com::sun::star::lang::XSingleServiceFactory::createInstance will create a new empty hierarchy data node. After it was created it's data members can be filled. Last, the node can be inserted as child of another node using ::com::sun::star::container::XNameContainer::insertByName.

There are no special arguments that must be supported by ::com::sun::star::lang::XSingleServiceFactory::createInstanceWithArguments

::com::sun::star::util::XChangesBatch
Description
allows managing changes within the hierarchy.

::com::sun::star::util::XChangesBatch::getPendingChanges reports all changes within the hierarchy that are done through (direct or indirect) descendants of this element. The same set of changes is committed to persistent storage and/or made visible to other objects accessing the same data set, when ::com::sun::star::util::XChangesBatch::commitChanges is invoked.


 
Top of Page

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.