ColumnSorting
Overview
The ColumnSorting class represents information about sorting data in the result data table.
Used in configuration of TableRequestInfo instances to define the sort mode of the returned data.
Location
- Reference: com.remobjects.dataabstract.jar
- Package: com.remobjects.dataabstract.intf
- Ancestry: Object | ComplexType | ColumnSorting
constructor protected (declared in ComplexType)
Default constructor.
constructor
ColumnSorting()
FieldName
property FieldName: String read write;
String FieldName { __get; __set; }
getAttributeValue (declared in ComplexType)
Returns attribute.
method getAttributeValue(aName: String): String
String getAttributeValue(String aName)
Parameters:
- aName: Given name.
readFromMessage
Initializes the current instance from the given message.
method readFromMessage(aName: String; aMessage: Message)
void readFromMessage(String aName, Message aMessage)
Parameters:
- aName: The name of the object to get from the message.
- aMessage: The message to be used in initialization.
setDefaultValues
Static helper method that allows to set default values to the all new instances of the ColumnSorting object.
class method setDefaultValues(p_FieldName: String; p_SortDirection: ColumnSortDirection)
static void setDefaultValues(String p_FieldName, ColumnSortDirection p_SortDirection)
Parameters:
- p_FieldName:
- p_SortDirection:
SortDirection
property SortDirection: ColumnSortDirection read write;
ColumnSortDirection SortDirection { __get; __set; }
writeToMessage
Serializes instance content using the given message.
method writeToMessage(aName: String; aMessage: Message)
void writeToMessage(String aName, Message aMessage)
Parameters:
- aName: The name that should be used to store the instance in the message.
- aMessage: The message to write the data of the class instance.
FieldName
property FieldName: String read write;
String FieldName { __get; __set; }
SortDirection
property SortDirection: ColumnSortDirection read write;
ColumnSortDirection SortDirection { __get; __set; }
setDefaultValues
Static helper method that allows to set default values to the all new instances of the ColumnSorting object.
class method setDefaultValues(p_FieldName: String; p_SortDirection: ColumnSortDirection)
static void setDefaultValues(String p_FieldName, ColumnSortDirection p_SortDirection)
Parameters:
- p_FieldName:
- p_SortDirection:
constructor protected (declared in ComplexType)
Default constructor.
constructor
ColumnSorting()
getAttributeValue (declared in ComplexType)
Returns attribute.
method getAttributeValue(aName: String): String
String getAttributeValue(String aName)
Parameters:
- aName: Given name.
readFromMessage
Initializes the current instance from the given message.
method readFromMessage(aName: String; aMessage: Message)
void readFromMessage(String aName, Message aMessage)
Parameters:
- aName: The name of the object to get from the message.
- aMessage: The message to be used in initialization.
writeToMessage
Serializes instance content using the given message.
method writeToMessage(aName: String; aMessage: Message)
void writeToMessage(String aName, Message aMessage)
Parameters:
- aName: The name that should be used to store the instance in the message.
- aMessage: The message to write the data of the class instance.