Whitebeam Template Reference Documentation

Site Map
 
Home
 
Application Guide
Reference
  Installation
  Configuration
  XML Markup
  JavaScript Classes
  ROM
  Templates
  Environment
  Dev Process
  Tools
  External Links
  Example libraries
Community
Contact Whitebeam
To-Do
Download
Credits
Licence
Whitebeam Users
 
 
 

Whitebeam Template Reference Documentation

Contact Template

get()

Searches for individuals, OUs, or communities in the contacts database.

Syntax

dataIterator = rb.contact.get(keywords, flags)

Parameters

The 'get' method takes 2 parameters:

Name Type/Value Range/Length Description
keywordsarray of stringsarray of 0-10 keyword strings, of < 128 characters each Required. A list of up to 10 keywords to be searched for. Keywords are additive (that is to say that searches will match any entry which contains any of the keywords
flagsstruct searchFlagssee definition Required. Flags, see definition of searchflags

Results

The 'get' method returns an iterator of structure:

Type/Value Range/Length Description
struct data see definitionsearch results

Remarks

The keywords array holds a list of all keywords to be searched for. Wildcards of % (representing any length of unspecified characters) and _ (representing a single unspecified character) can be used in the search. These characters may be introduced by the integration partners implicitly or typed in by the user. This will mean however that these characters may not themselves be searched for. Only alphabetical characters and numbers may be used in a search.

Example

The following example gets all Individual entities which contain "Fred", or "Joe" in their name field, printing out the names

	  var flags = {searchIndividual:1, searchOU:0, searchCommunity:0, searchName:1};
	  var keywords = ["Fred", "Joe"]
	  var results = rb.contact.get(keywords, flags);
	  while(results.getNextRow())
	  rb.page.write("Search matched " + results.name +"<BR>");
	
Whitebeam release 1.3.36
(loadtime : 188ms)