:: com :: sun :: star :: container ::
|
interface XContainerQuery |
|
- Description
- supports simple query feature on a container
This interface makes it possible to create sub sets of container items
which serve specified search criterion.
|
Methods' Details |
createSubSetEnumerationByQuery
XEnumeration |
createSubSetEnumerationByQuery( |
[in] string |
Query ); |
- Description
- creates a sub set of container items which match given query command
Items of this sub set must match used query string. Format of query depends
from real implementation. Using of "param=value" pairs isn't neccessary.
So it's possible to combine different parameters as one simple command
string.
- Parameter Query
- items of sub set must match to this query
example:
(1)
query as parameter sequence to return all elements wich match
the name pattern and supports a special feature; sort it ascending
"name=*myname_??_;sort=ascending;feature=VISIBLE"
(2)
query as command to return all elements which support special feature
and match by name pattern;ascending sort is the default
"getAllVisible(*myname_??_)"
- Returns
- an sub set of container items as an enumeration.
|
|
createSubSetEnumerationByProperties
- Description
- creates a sub set of container items which supports searched properties as minimum
It's not possible to use special commands or search specific parameters here.
You can match by properties only. Enumerated elements must provide queried
properties as minimum. Not specified properties willn't be used for searching.
- Parameter Properties
- items of sub set must support given properties as minimum
example:
(supported)
search for items wich match the name pattern and supports the VISIBLE feature
Parameters[0].Name = "name"
Parameters[0].Value = "*myname_??_"
Parameters[1].Name = "feature"
Parameters[1].Value = "VISIBLE"
...
(unsupported)
"sort" isn't a property of a container item!
Parameters[0].Name = "sort"
Parameters[0].Value = "ascending"
...
- Returns
- an sub set of container items as an enumeration.
|
|
Top of Page
Copyright © 2012, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.