OpenWGA 7.10 - TMLScript reference


Object:

CollectionPage

Description A part of a collection result containing a list of result documents
Retrieval This is a special variant of the List object which contains the result documents as TMLContext objects but additionally provides method to retrieve information about the collection page.
Allowed in script types
  • WebTML pages and normal WebTML actions
  • Master actions
  • TMLScript tasks in jobs
  • Content type events
Inherits from object List
Properties and methods
Name Purpose
add([index, ] value) Adds a value to the list
addAll([index,] list) Adds all values of another list to this list
clear() Removes all values  from the list
contains(value) Controls if a value is contained in the list
containsAll(list) Controls if this list contains all values of another list
endIndex Denotes the index that the last document on this collection page had on the original collection
endReached Denotes if there are retrievable result documents in the collection after the last document of this collection page
equals(list) Tests two lists for equality
get(idx) Reads a value from the list
indexOf(value) Returns the index position of a value in the list
isEmpty() Controls if the list is empty
lastIndexOf(value) Returns the (last) index position of a value in the list
remove(value)
remove(idx)
Removes a value from the list
removeAll(list) Removes all values from the list that are contained in the parameter list
retainAll(list) Removes all values from the list that are not contained in the parameter list
set(idx, value) Sets a value at an index position
size() Returns the number of values in the list
endIndex Denotes the index that the first document on this collection page had on the original collection
subList(from ,to) Extracts a partial list
toArray() Creates a JavaScript array containing the list values