com.datalogics.PDFL

Class CollectionSortItem

java.lang.Object

com.datalogics.PDFL.CollectionSortItem

public class CollectionSortItem
extends java.lang.Object

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

Constructor Summary

Constructors

Constructor and Description
CollectionSortItem(java.lang.String fieldID, boolean order) CCollectionSortItem allows to construct sort item which will be used for collection sorting.

Method Summary

Modifier and Type	Method and Description
void	delete()
boolean	getAscending() GetAscending allows to know whether ascending order is used for sorting.
java.lang.String	getName() GetName allows to get name to sort by.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CollectionSortItem

public CollectionSortItem(java.lang.String fieldID,
                          boolean order)

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

Parameters:

fieldID - the schema field's id.

order - true for ascending, false for descending

Method Detail

delete

public void delete()

getName

public java.lang.String getName()

GetName allows to get name to sort by.

Returns:

the filed name to sort by

getAscending

public boolean getAscending()

GetAscending allows to know whether ascending order is used for sorting.

Returns:

sort order