com.ptc.windchill.enterprise.change2.tableViews
Class ChangeTableViews

java.lang.Object
  com.ptc.core.htmlcomp.tableview.AbstractConfigurableTable
      com.ptc.core.htmlcomp.components.JCAConfigurableTable
          com.ptc.windchill.enterprise.change2.tableViews.ChangeTableViews

All Implemented Interfaces:

com.ptc.core.htmlcomp.components.JCAMappable, com.ptc.core.htmlcomp.tableview.ConfigurableTable

Direct Known Subclasses:

AbstractListChangeItemTableViews, AffectedDataTableViews, AffectedEndItemsTableViews, AssociatedChangeIssuesTableViews, AssociatedChangeRequestsTableViews, ChangeTaskAffectedItemsTableViews, ChangeTaskResultingItemsTableViews

public abstract class ChangeTableViews
extends com.ptc.core.htmlcomp.components.JCAConfigurableTable

Configures the default views for the Change Management Tables.

Supported API: true

Extendable: false

Method Summary

boolean	canAttributeBeUsedInFilter(String attributeId) Abstract method check if attribute can be used by the filter.
List<com.ptc.core.htmlcomp.tableview.TableViewDescriptor>	createCommonTableViews(String tableId, Locale locale) Creates a list of TableViewDescriptors for all of the common table views shown for changeable tables.
List<com.ptc.core.htmlcomp.tableview.TableViewDescriptor>	createTableView(String tableId, String viewName, Locale locale, Vector<com.ptc.core.htmlcomp.tableview.TableViewCriterion> criterion) Creates the table view descriptors for a new view.
protected static Class[]	getChangeableClasses() Helper method to return the registered changeable classes.
abstract Class[]	getClassTypes() Method to get an Array of Class types for the table views.
String	getDefaultSortColumn() Method to get the default column to sort on table views.
protected String	getDefaultViewDescription(String viewName) Method to get the default view description.
abstract String	getLabel(Locale locale) Method to get the label for the table views.
protected abstract List<String>	getLockedColumns() Retrieve the locked columns for the table view.
String	getOOTBActiveViewName() Method to get the out of the box active table view name.
abstract List	getOOTBTableViews(String tableId, Locale locale) Sets the default table view and returns a list of out of the box table views.
abstract List	getSpecialTableColumnsAttrDefinition(Locale locale) Abstract method get special tablec columns attribute definitions.
boolean	isColumnLocked(String columnId) Abstract method to check if the column is to be locked.
protected void	setDefaultSortColumnOrder(com.ptc.core.htmlcomp.tableview.TableViewDescriptor tableViewDescriptor) Method to set the sortable columns for a table view.

Methods inherited from class java.lang.Object

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

Method Detail

canAttributeBeUsedInFilter

public boolean canAttributeBeUsedInFilter(String attributeId)

Abstract method check if attribute can be used by the filter.

Supported API: true

Overrides:

canAttributeBeUsedInFilter in class com.ptc.core.htmlcomp.tableview.AbstractConfigurableTable

Parameters:

attributeId - Passes in the id of the attribute

Returns:

boolean Returns true if it can be filtered

isColumnLocked

public boolean isColumnLocked(String columnId)

Abstract method to check if the column is to be locked.

Supported API: true

Overrides:

isColumnLocked in class com.ptc.core.htmlcomp.tableview.AbstractConfigurableTable

Parameters:

columnId - Passes in the columnId

Returns:

boolean Return true for locked and false for not locked.

createTableView

public List<com.ptc.core.htmlcomp.tableview.TableViewDescriptor> createTableView(String tableId,
                                                                                 String viewName,
                                                                                 Locale locale,
                                                                                 Vector<com.ptc.core.htmlcomp.tableview.TableViewCriterion> criterion)
                                                                          throws WTException

Creates the table view descriptors for a new view. The criteria is provided within the input parameters.

Supported API: true

Parameters:

tableId - The id of the table (used in encoding the table view)

viewName - The unique name of the view

locale - The locale to be used.

criterion - The vector of criteria to set on the table.

Returns:

result Return a list of out of the box table view descriptors.

Throws:

WTException

createCommonTableViews

public List<com.ptc.core.htmlcomp.tableview.TableViewDescriptor> createCommonTableViews(String tableId,
                                                                                        Locale locale)
                                                                                 throws WTException

Creates a list of TableViewDescriptors for all of the common table views shown for changeable tables. This will include views for All, Parts, Documents, CAD Documents, Dynamic Documents and MPMLink Process Plans and Resources if installed.

Supported API: true

Returns:

result Return a list of OOTB common table views.

Throws:

WTException

getChangeableClasses

protected static Class[] getChangeableClasses()

Helper method to return the registered changeable classes.

Supported API: true

getLabel

public abstract String getLabel(Locale locale)

Method to get the label for the table views.

Supported API: true

Parameters:

locale - Passes in the Locale

Returns:

String Returns the label for the table views.

getOOTBActiveViewName

public String getOOTBActiveViewName()

Method to get the out of the box active table view name.

Supported API: true

Returns:

String Returns the out of the box active table view name.

getDefaultSortColumn

public String getDefaultSortColumn()

Method to get the default column to sort on table views.

Supported API: true

Returns:

String Returns the default column to sort on table views.

setDefaultSortColumnOrder

protected void setDefaultSortColumnOrder(com.ptc.core.htmlcomp.tableview.TableViewDescriptor tableViewDescriptor)
                                  throws WTException

Method to set the sortable columns for a table view.

Supported API: true

Throws:

WTException

getDefaultViewDescription

protected String getDefaultViewDescription(String viewName)

Method to get the default view description.

Supported API: true

Returns:

String Returns the default view description.

getClassTypes

public abstract Class[] getClassTypes()

Method to get an Array of Class types for the table views.

Supported API: true

Returns:

Class[] Returns an Array of Class types for the table views.

getOOTBTableViews

public abstract List getOOTBTableViews(String tableId,
                                       Locale locale)
                                throws WTException

Sets the default table view and returns a list of out of the box table views.

Supported API: true

Parameters:

tableId - Passes in the table id

locale - Passes in the Locale

Returns:

result Return a list of out of the box table views.

Throws:

WTException

getSpecialTableColumnsAttrDefinition

public abstract List getSpecialTableColumnsAttrDefinition(Locale locale)

Abstract method get special tablec columns attribute definitions.

Supported API: true

Parameters:

locale - Passes in the locale

Returns:

List Returns a list of attribute definitions.

getLockedColumns

protected abstract List<String> getLockedColumns()

Retrieve the locked columns for the table view.

Supported API: true

Returns:

Map Ordered Map of column Ids and whether it is locked.