(incubating) | The Free and Open Productivity Suite
Announcing Apache OpenOffice 3.4

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous

Content for OpenOffice.org version 3.3.
Overview Module Use Devguide Index
Elements' Summary Elements' Details

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

struct SearchInfo
Description
information needed to (recursively) search an object.
Elements' Summary
Criteria the search criteria.  
Recursion the mode of recursion to use.  
IncludeBase whether to include the object itself in the search or only (some of) its sub-objects.  
RespectFolderViewRestrictions whether to respect the "view restrictions" specified for the folders hierarchically contained within an object (e.g., only searches through subscribed folders).  
RespectDocViewRestrictions whether to respect the "view restrictions" specified for the documents hierarchically contained within an object (e.g., only searches through marked documents).  
FollowIndirections whether to follow indirections (link objects) and search through their respective targets also.  
Elements' Details
Criteria
sequence< SearchCriterium > Criteria;
Description
the search criteria.
Recursion
SearchRecursion Recursion;
Description
the mode of recursion to use.
IncludeBase
boolean IncludeBase;
Description
whether to include the object itself in the search or only (some of) its sub-objects.
RespectFolderViewRestrictions
boolean RespectFolderViewRestrictions;
Description
whether to respect the "view restrictions" specified for the folders hierarchically contained within an object (e.g., only searches through subscribed folders).
RespectDocViewRestrictions
boolean RespectDocViewRestrictions;
Description
whether to respect the "view restrictions" specified for the documents hierarchically contained within an object (e.g., only searches through marked documents).
FollowIndirections
boolean FollowIndirections;
Description
whether to follow indirections (link objects) and search through their respective targets also.
Top of Page

Copyright © 1995, 2010, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Apache Feather

Copyright & License | Privacy | Contact Us

Apache and the Apache feather logos are trademarks of The Apache Software Foundation. OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.

Apache OpenOffice is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.