:: com :: sun :: star :: configuration :: backend ::

service HierarchyBrowser

Exported Interfaces - Summary
::com::sun::star::task::XJob

allows executing a scan of the repository (details)

Exported Interfaces - Details
::com::sun::star::task::XJob
Description
allows executing a scan of the repository

The repository to browse is selected by arguments passed to com::sun::star::task::XJob::execute(). The names and meanings of such arguments depend on the implementation. Each implementation must document such arguments.

The following argument to com::sun::star::task::XJob::execute() must be supported by all implementations:

ExcludeComponents : `string[]` or `string`
A component or list of components that should be skipped and excluded from the result. If this argument appears multiple times it is handled cumulatively.

The return value of com::sun::star::task::XJob::execute() is a list of components found. The format in which components are returned may depend on the implementation. Each implementation should support returning component identifiers that are compatible with some implementation of Backend.


 
Top of Page