wt.templateutil.table
Class ColumnSortService

java.lang.Object
  wt.templateutil.table.ColumnSortService

Deprecated.

public class ColumnSortService
extends Object

Deprecation Notice: This class is still valid for this release, however this serves as advance notice that it will be removed in the future. All user interfaces built using the Windchill HTML Template Processing client architecture will be rewritten using a different framework in an upcoming release.

This class tracks a user's preferences for which column to use for sorting a table and the order in which sorting should be done. It updates the user's preference based on the formData of the current page and retrieves preference information when sorting is to be done.

Supported API: true

Extendable: false

Constructor Summary

ColumnSortService(HTTPState state)
Deprecated.

Method Summary

String	getSortedColumnName(String tableName) Deprecated.
boolean	isSortAscending(String tableName, String columnName) Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

ColumnSortService

public ColumnSortService(HTTPState state)
                  throws WTException

Deprecated.

Constructs an instance of the ColumnSortService and updates the user's sorting preferences based on the form data of the current page.

Parameters:

HTTPState - HTTPState object associated with the current page

Supported API: true

Throws:

WTException

Method Detail

isSortAscending

public boolean isSortAscending(String tableName,
                               String columnName)

Deprecated.

Returns true if the given column should be sorted in ascending order, false if descending

Parameters:

tableName - name of the table as returned by the HTMLComponent.getName() method

columnName - name of the column by which the table is sorted

Supported API: true

getSortedColumnName

public String getSortedColumnName(String tableName)

Deprecated.

Gets the name of the column by which a table should be sorted

Parameters:

tableName - name of the table as returned by the HTMLComponent.getName() method

Supported API: true