Caplin Trader 4.8.0

Interface: module:caplin/grid/sort/SortRule

module:caplin/grid/sort/SortRule

The interface that must be implemented by any class that wants to define a particular rule or set of rules that can be used to sort a set of record data.
Implementations:

Methods

getRttpState() → {String}

Gets a serialized representation of this SortRule to send via RTTP to the Liberator which will apply it. This format must be understood by the DataSource, such as the Container Filtering Module used by the Transformer, that will execute the sort.
Implementations:
  • module:caplin/grid/sort/FieldSortRule#getRttpState
Returns:
A serialized representation of this rule that can be sent over RTTP.
Type
String

getSerializedState(sIndent) → {String}

Gets an XML representation of this SortRule that will be used to save its state within a serialized component and/or layout.
Parameters:
Name Type Description
sIndent String The number of characters the caller would like the expression to indent the XML it returns to make it easily human readable.
Implementations:
  • module:caplin/grid/sort/FieldSortRule#getSerializedState
Returns:
An XML representation of this rule.
Type
String