Package com.ptc.windchill.enterprise.workSet.views

Class RelatedWorkSetTableViews

java.lang.Object

com.ptc.core.htmlcomp.tableview.AbstractConfigurableTable

com.ptc.core.htmlcomp.components.JCAConfigurableTable

com.ptc.windchill.enterprise.workSet.views.RelatedWorkSetTableViews

All Implemented Interfaces:

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

public class RelatedWorkSetTableViews
extends JCAConfigurableTable

Configures the default views available for the Related Work Sets table.

Supported API: true

Extendable: true

Nested Class Summary

Nested classes/interfaces inherited from interface com.ptc.core.htmlcomp.tableview.ConfigurableTable

ConfigurableTable.ContextTypeForCustomize

Field Summary

Fields inherited from class com.ptc.core.htmlcomp.tableview.AbstractConfigurableTable

ALL_REV_ITER_KEY, LATEST_REV_ITER_KEY

Fields inherited from interface com.ptc.core.htmlcomp.tableview.ConfigurableTable

TABLE_TITLE

Method Summary

Modifier and Type	Method	Description
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.
Class[]	getClassTypes()	Get an array of classes available for display in the table views.
protected List<String>	getDefaultColumns()	Retrieve the default columns for the table view.
protected String	getDefaultViewDescription(String viewName)	Method to get the default view description.
String	getLabel(Locale locale)	Get the label for the table views.
protected 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.
List	getOOTBTableViews(String tableId, Locale locale)	Returns a list of out of the box table views.
List	getSpecialTableColumnsAttrDefinition(Locale locale)	Get special table columns attribute definitions.
protected com.ptc.core.htmlcomp.tableview.TableViewDescriptor	getTableViewDescriptor(String viewName, Locale locale, Vector<com.ptc.core.htmlcomp.tableview.TableViewCriterion> criteria)	Method to initialize the table descriptor.
protected void	setDefaultSortColumnOrder(com.ptc.core.htmlcomp.tableview.TableViewDescriptor tableViewDescriptor)	Method to set the sortable columns for a table view.

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

getMessageSource, isFreezable, isMappingEnabled

Methods inherited from class com.ptc.core.htmlcomp.tableview.AbstractConfigurableTable

canAttributeBeUsedInFilter, getActionStatusAttrDef, getAdvRevisionAllCriterion, getAdvRevisionAttrDef, getAdvRevisionLatestCriterion, getAdvVersionAllCriterion, getAdvVersionAttrDef, getAdvVersionLatestCriterion, getAttributeOnlyClassTypes, getChangeStatusAttrDef, getContextProperties, getContextProperty, getLocalStatusAttrDef, getMessageStatusAttrDef, getNewOrganizationAttrDef, getOrganizationAttrDef, getRuntimeTableView, getSandboxStatusAttrDef, getServerStatusAttrDef, getStatusColumnsAttributeDefinitions, getStatusColumnsAttributeDefinitions, getStatusColumnsTableColumnDefinitions, getStatusColumnsTableColumnDefinitions, getViewResourceEntryKey, getWsContentStatusAttrDef, isAttributeValidForColumnStep, isAttributeValidForSortingStep, isColumnLocked, isDefaultSortingAscending, setContextProperties, setRuntimeTableView, showChooseItemTypesStep, showFilteringStep, showSetColumnsStep, showSetNameStep, showSortingStep, useBusinessFields

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ptc.core.htmlcomp.tableview.ConfigurableTable

canAttributeBeUsedInFilter, getAttributeOnlyClassTypes, getContextProperties, getContextProperty, getContextTypeForTableView, isAttributeValidForColumnStep, isAttributeValidForSortingStep, isColumnLocked, isDefaultSortingAscending, isLocalAttributesSupported, setContextProperties, showChooseItemTypesStep, showFilteringStep, showSetColumnsStep, showSetNameStep, showSortingStep, useBusinessFields

Method Details

getClassTypes

public Class[] getClassTypes()

Get an array of classes available for display in the table views.

Supported API: true

Returns:

List of classes that are supported by table.

Supported API: true

getLabel

public String getLabel(Locale locale)

Get the label for the table views.

Supported API: true

Parameters:

locale - Language for label.

Returns:

Returns label of object.

Supported API: true

getOOTBTableViews

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

Returns a list of out of the box table views.

Supported API: true

Parameters:

tableId - Id of table.

locale - Language for table.

Returns:

Get the Out Of The Box table views.

Throws:

WTException - Error thrown during execution.

Supported API: true

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

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

getTableViewDescriptor

protected com.ptc.core.htmlcomp.tableview.TableViewDescriptor getTableViewDescriptor(String viewName,
 Locale locale,
 Vector<com.ptc.core.htmlcomp.tableview.TableViewCriterion> criteria)
                                                                              throws WTException

Method to initialize the table descriptor.

Supported API: true

Returns:

TableViewDescriptor Returns the initialized the table view descriptor.

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.

getSpecialTableColumnsAttrDefinition

public List getSpecialTableColumnsAttrDefinition(Locale locale)

Get special table columns attribute definitions. There are no special table column attributes defined by this TableView.

Supported API: true

Parameters:

locale - Language for attribute.

Returns:

Special Table Column Attribute for given locale.

Supported API: true

getLockedColumns

protected List<String> getLockedColumns()

Retrieve the locked columns for the table view.

Supported API: true

getDefaultColumns

protected List<String> getDefaultColumns()

Retrieve the default columns for the table view.

Supported API: true

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.