Package 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, ConfigurableTable, com.ptc.core.htmlcomp.tableview.FreezableConfigurableTable, com.ptc.core.htmlcomp.tableview.RuntimeTableViewHolder
Direct Known Subclasses:
AbstractListChangeItemTableViews, AffectedDataTableViews, AffectedEndItemsTableViews, AssociatedChangeIssuesTableViews, AssociatedChangeRequestsTableViews, AssociatedChangeTableViews, ChangeTaskAffectedItemsTableViews, ChangeTaskResultingItemsTableViews, CollectAffectedObjectsJSTableViews
public abstract class ChangeTableViews extends JCAConfigurableTable
Configures the default views for the Change Management Tables.

Supported API: true

Extendable: false

  • Method Details

    • canAttributeBeUsedInFilter

      public boolean canAttributeBeUsedInFilter(String attributeId)
      Abstract method check if attribute can be used by the filter.

      Supported API: true
      Specified by:
      canAttributeBeUsedInFilter in interface ConfigurableTable
      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
      Specified by:
      isColumnLocked in interface ConfigurableTable
      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

    • 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

    • getCriteria

      protected Vector<com.ptc.core.htmlcomp.tableview.TableViewCriterion> getCriteria() throws WTException
      Method to get the criteria.

      Supported API: true
      Returns:
      Vector Returns the criteria.
      Throws:
      WTException

    • getChangeableClasses

      protected static Class[] getChangeableClasses()
      Helper method to return the array of registered changeable classes.

      Supported API: true

    • getObjTypeKey

      protected String getObjTypeKey(Class a_class) throws WTException
      Helper method to return the object type key.

      Supported API: true
      Throws:
      WTException

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

      Supported API: true

    • getSpecialTableColumnsAttrDefinition

      public List getSpecialTableColumnsAttrDefinition(Locale locale)
      Get base special table columns attribute definitions for change tables.

      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:
      Mapinvalid input: '<'String,Boolean> Ordered Map of column Ids and whether it is locked.