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

rb.collection.arcQueryData

Iterator data type representing an arc

Elements

The rb.collection.arcQueryData struct has 10 elements:

Name Type/Value Range/Length Description
arcTypestring1-50 characters Required. Type of this collection (eg 'forum membership')
arcTypeIDnumber  Required. The numeric type ID for this arc
sourceTypestringC, I or N Required. 'C':contact, 'I':item, 'N':node
sourceIDnumber  Required. The numeric ID of the source element for this link. Only useful if a starting node has *not* been specified
targetTypestringC, I or N Required. 'C':contact, 'I':item, 'N':node
subTypestring0-10 characters Optional. The short filter string logged against this arc
targetIDnumber  Required. ID of the target for this arc
timestampnumber  Optional. Time stamp stored against this record
relationDataMetaData  Optional. A link record represents a relationship between the collection owner and the target. This field allows the application to store application specific data that describes in more detail information about the relationship between the owner and the member
targetMetaData  Optional. Details of the item at the end of the specified arc. The contents of this object will vary depending on the value of 'type' and with the value of 'allData' in the iterator request. With a value for allData of 0 (zero) this object is not created. Details are held in the tutorial on the collection template.

Remarks

This is the type definition for the iterator returned by rb.collection.getArcs. The values returned depend on the attribute values in the arcSearchType object passed to 'getArcs'.

Whitebeam release 1.3.36
(loadtime : 183ms)