CollectionSortItem Class Documentation

class CollectionSortItem

Namespace:datalogics_interface

Detailed Description

Stores data about fields that viewers use for sorting collection items.

Collections are aslo known as portfolios.

Referenced by

Constructor & Destructor Documentation

CollectionSortItem

CollectionSortItem(const std::string & field_id, bool ascending)

Parameters

field_id: const std::string &

the schema field's id.

ascending: bool

true for ascending, false for descending

CCollectionSortItem allows to construct sort item which will be used for collection sorting.

Member Function Documentation

get_ascending

bool get_ascending()

Returns:

bool

true if the sort order is ascending, false if descending.

Gets whether the sort order is ascending.

get_name

std::string get_name()

Returns:

std::string

The field name to sort by.

Gets the field name used for sorting.

This is the schema field identifier that determines which collection field is used as the sort key.