Package com.ptc.windchill.enterprise.change2.tableViews

Class ChangeSummaryTableViews

java.lang.Object

com.ptc.core.htmlcomp.tableview.AbstractConfigurableTable

com.ptc.core.htmlcomp.components.JCAConfigurableTable

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

com.ptc.windchill.enterprise.change2.tableViews.ChangeTaskAffectedItemsTableViews

com.ptc.windchill.enterprise.change2.tableViews.ChangeSummaryTableViews

All Implemented Interfaces:

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

Direct Known Subclasses:

WorkflowTaskChangeSummaryTableViews

public class ChangeSummaryTableViews
extends ChangeTaskAffectedItemsTableViews

Table views for the Change Notice summary table. The affected and resulting objects in the Change Notice Change Tasks can be additionally filtered for performance by adding an additional attribute to filter the affected, resulting or to show all affected and resulting objects in the table. The query is optimized to only get the affected or resulting object when specified properly in the view filter wizard. This can be done by adding the "Impacting Objects" attribute and setting the value equal to 'Affected Objects', 'Resulting Objects' or 'Affected/Resulting Objects' in the table view wizard. To show both affected and resulting objects filtering on the 'Impacting Objects' is not required.

Supported API: true

Extendable: true

Method Summary

Modifier and Type	Method	Description
String	getLabel(Locale locale)	Method to get the label for the table views.
List	getOOTBTableViews(String tableId, Locale locale)	Sets the default table view and returns a list of out of the box table views.
List<?>	getSpecialTableColumnsAttrDefinition(Locale locale)	Adds the attribute 'Impacting Objects' to filter the affected, resulting or to show all affected and resulting objects in the table.
boolean	isAttributeValidForColumnStep(String key)	Filters the columns used for filtering the affected and resulting objects.

Methods inherited from class com.ptc.windchill.enterprise.change2.tableViews.ChangeTaskAffectedItemsTableViews

getClassTypes

Methods inherited from class com.ptc.windchill.enterprise.change2.tableViews.ChangeTableViews

createCommonTableViews, createTableView, getChangeableClasses, getCriteria, getDefaultSortColumn, getDefaultViewDescription, getObjTypeKey, getTableViewDescriptor, isColumnLocked, setDefaultSortColumnOrder

Methods inherited from class com.ptc.core.htmlcomp.components.JCAConfigurableTable

isMappingEnabled

Methods inherited from class java.lang.Object

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

Method Details

getOOTBTableViews

public 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

Specified by:

getOOTBTableViews in interface ConfigurableTable

Overrides:

getOOTBTableViews in class ChangeTaskAffectedItemsTableViews

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 - Error thrown during execution.

Supported API: true

getSpecialTableColumnsAttrDefinition

public List<?> getSpecialTableColumnsAttrDefinition(Locale locale)

Adds the attribute 'Impacting Objects' to filter the affected, resulting or to show all affected and resulting objects in the table.

Supported API: true

Specified by:

getSpecialTableColumnsAttrDefinition in interface ConfigurableTable

Overrides:

getSpecialTableColumnsAttrDefinition in class ChangeTaskAffectedItemsTableViews

Parameters:

locale - Passes in the locale

Returns:

List Returns a list of attribute definitions.

isAttributeValidForColumnStep

public boolean isAttributeValidForColumnStep(String key)

Filters the columns used for filtering the affected and resulting objects.

Supported API: true

Specified by:

isAttributeValidForColumnStep in interface ConfigurableTable

Overrides:

isAttributeValidForColumnStep in class ChangeTableViews

Parameters:

key - Key of Attribute.

Returns:

Is Attribute Valid for column step or not.

Supported API: true

getLabel

public String getLabel(Locale locale)

Method to get the label for the table views.

Supported API: true

Specified by:

getLabel in interface ConfigurableTable

Overrides:

getLabel in class ChangeTaskAffectedItemsTableViews

Parameters:

locale - Passes in the Locale

Returns:

String Returns the label for the table views.