CollectionSortItem Class Documentation

class CollectionSortItem

Namespace:com::datalogics::PDFL

Detailed Description

Stores data about fields that viewers use for sorting collection items. Collections are aslo known as portfolios.

Referenced by

CollectionCollectionSortItemPtrVector

Constructor & Destructor Documentation

CollectionSortItem

CollectionSortItem(String fieldID, boolean order)

Parameters

fieldID: String

the schema field's id.

order: boolean

true for ascending, false for descending

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

Member Function Documentation

delete

synchronized void delete(Boolean disposing)

Parameters

disposing: Boolean

Returns:

synchronized void

delete

synchronized void delete()

Returns:

synchronized void

finalize

void finalize()

Returns:

void

getAscending

boolean getAscending()

Returns:

boolean

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

Gets whether the sort order is ascending.

getName

String getName()

Returns:

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.