OpenWGA 7.9 - TMLScript reference



Description Represents a CollectionResult from a WebTML navigator collection, containing all documents of that navigator

Nav.navigate() and Nav convenience methods for individual navigator types

Allowed in script types
  • WebTML pages and normal WebTML actions
  • Master actions
  • TMLScript tasks in jobs
  • Content type events
Inherits from object CollectionResult
Properties and methods
Name Purpose
contains(context) inherited

contains(ctx) takes a WGContext object as parameter and checks if this context is contained in the collection result.

each(function) inherited Applies a function to each element of the collection result.
exclude(context) inherited Filters out the given document from the collection result
filter(function) inherited Applies a filter to the collection result
firstResult inherited Returns the first result document of the collection
firstResultContent inherited Returns the first result document of the collection as WGAPI content object
getPage([offset,] size) inherited Returns a page of result documents
getSingleValue(itemName) inherited Returns the value of an item from the first result document of this collection
isEmpty() inherited Tests if the result has at last one elements, the current user can read.
map(function) inherited map(function) takes a JS-Function as parameter. This function is called for each result entry with the TMLContext as parameter and must return some value. The return value of map() is a list of all mapped values.
onlyPublished Reports if the collection result returns only published documents
originalResult inherited Returns the original QueryResult or NavigatorResult of this collection result
size inherited Returns the number of result documents in the collection
skip(size) inherited Skips the first documents in the current collection result
Examples See CollectionResult