OpenWGA 7.10 - 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(ctx) takes a WGContext object as parameter and checks if this context is contained in the collection result.

each(function) Applies a function to each element of the collection result.
exclude(context) Filters out the given document from the collection result
filter(function) Applies a filter to the collection result
firstResult Returns the first result document of the collection
firstResultContent Returns the first result document of the collection as WGAPI content object
getPage([offset,] size) Returns a page of result documents
getSingleValue(itemName) Returns the value of an item from the first result document of this collection
groupMap(function [,descending]) This method creates and returns a sorted map keyed by the return value of a user defined function where its value is a list of TMLContext objects evaluating to the same key.
isEmpty() Tests if the result has at last one elements, the current user can read.
map(function) 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 Returns the original QueryResult or NavigatorResult of this collection result
size Returns the number of result documents in the collection
skip(size) Skips the first documents in the current collection result
Examples See CollectionResult