CollectionSortItem Class Documentation

classCollectionSortItem

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(StringfieldID, booleanorder)

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

DisposeChildren

voidDisposeChildren()

Returns:

void

[static initializer]

static void[static initializer]()

delete

synchronized voiddelete(Booleandisposing)

Parameters

disposing: Boolean

Returns:

synchronized void

delete

synchronized voiddelete()

Returns:

synchronized void

finalize

voidfinalize()

Returns:

void

getAscending

booleangetAscending()

Returns:

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

Gets whether the sort order is ascending.

getName

StringgetName()

Returns:

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.