Home | Class Index

SDK Version: 3.11.4-302512

Documentation generated on 24 July 2015

Interface
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.

Constructor Summary

Attributes Name and Description
caplin.grid.sort.SortRule()

Method Summary

Attributes Name and Description
String getRttpState()

Gets a serialized representation of this SortRule to send via RTTP to the Liberator which will apply it.
String getSerializedState(String sIndent)

Gets an XML representation of this SortRule that will be used to save its state within a serialized component and/or layout.

Constructor Detail

► caplin.grid.sort.SortRule()

Method Detail

► String getRttpState()

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.

Returns
A serialized representation of this rule that can be sent over RTTP.

► String getSerializedState(String sIndent)

Gets an XML representation of this SortRule that will be used to save its state within a serialized component and/or layout.

Parameters
String sIndent The number of characters the caller would like the expression to indent the XML it returns to make it easily human readable.
Returns
An XML representation of this rule.