|
Whitebeam Object Definition
|
Method Description
Interest.get()
Search the set of existing interest groups.
Syntax
Interest.InterestIterator = Interest.get(strings, flags)
Parameters
The 'Interest.get' method takes 2 parameters:
Name | Type/Value | Range/Length | Description | strings | array of strings | array of 0-10 search strings, of < 128 characters each | Optional. A list of up to 10 string fragments to locate. Matches are additive (that is to say that searches will match any entry which contains any of the strings | flags | struct Interest.searchFlags | see definition | Optional. Flags, see definition of searchflags |
Results
This method returns an instance of InterestIt - the Interest Group iterator. The iterator inherits from Interest class and
adds the standard iterator methods (See the iterator tutorial for details). The formal definition
of the iterator methods can be found here. If called with no parameters this method returns an iterator for all interest groups.
Remarks
Search the interest groups for those that have one of a set of strings in their names. The search behaviour is modified by the value of the
searchFlags parameter.
| This is a static - or class method. It is always invoked on 'Interest' rather than on an instance of that class.
|
Example
// Get an iteretor for all existing interest groups.
// in their keyword list.
var iterator = Interest.get();
while (iterator.getNextRow()) {
// iterator can now be treated as an instance of Interest -
// that is it contains all the properties for this
// Interest Group as retrieved from the membership store.
}
|
|
(loadtime : 17ms) |