Package com.ptc.windchill.enterprise.object.views

Class ConfigurableLinkTableViews

java.lang.Object
com.ptc.core.htmlcomp.tableview.AbstractConfigurableTable
com.ptc.core.htmlcomp.components.JCAConfigurableTable
com.ptc.windchill.enterprise.object.views.ConfigurableLinkTableViews
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:
ConfigurableDescribeLinkTableViews, ConfigurableMastersLinkTableViews, ConfigurableReferenceLinkTableViews, ConfigurableRevisionLinkTableViews
public abstract class ConfigurableLinkTableViews extends JCAConfigurableTable
Configures the default views for the Configurable Links role object tables.

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
    Class[]
    getAttributeOnlyClassTypes()
    Gets the list of classes that are to be used only for supplying attributes These classes are not to be exposed to users in "Choose Item Types" step

    Supported API: true
    Class[]
    getClassTypes()
    Get the list of classes that are supported by this table These are supposed to reflect the object types that are shown in tables

    Supported API: true
    String
    getDefaultSortColumn()
    Gets the id of the columns that should be used by default for sorting

    Supported API: true
    String
    getLabel(Locale locale)
    Get the User visible name of the table

    Supported API: true
    String
    getOOTBActiveViewName()
    Get the name of the table view that should be the first one If null is returned, the first OOTB table view will be used as default

    Supported API: true
    List<com.ptc.core.htmlcomp.tableview.TableViewDescriptor>
    getOOTBTableViews(String tableId, Locale locale)
    Get the Out Of The Box table views

    Supported API: true
    List<com.ptc.core.htmlcomp.createtableview.Attribute.AbstractAttribute>
    getSpecialTableColumnsAttrDefinition(Locale locale)
    Gets the Attribute instances of the columns that are special for this table These attributes are considered as miscellaneous attributes/columns
    Supported API: true
    boolean
    isAttributeValidForColumnStep(String key)
    Validates if a given attribute should be available in the "set columns" Step of the create table view wizard

    Supported API: true
    boolean
    isColumnLocked(String columnId)
    tests if the column identified by columnId is a locked column that users cannot remove from their tables

    Supported API: true
    boolean
    isDefaultSortingAscending()
    Gets the Default sort order

    Supported API: true
    boolean
    showChooseItemTypesStep()
    Should return false if choosing item types is not supported in table (this step allows the user to choose the item types that are to be shown in an instance of the table view - this is filtering by item type)

    Supported API: true
    boolean
    showFilteringStep()
    Should return false if filtering is not supported in table

    Supported API: true

    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, getChangeStatusAttrDef, getContextProperties, getContextProperty, getLocalStatusAttrDef, getMessageStatusAttrDef, getNewOrganizationAttrDef, getOrganizationAttrDef, getRuntimeTableView, getSandboxStatusAttrDef, getServerStatusAttrDef, getStatusColumnsAttributeDefinitions, getStatusColumnsAttributeDefinitions, getStatusColumnsTableColumnDefinitions, getStatusColumnsTableColumnDefinitions, getViewResourceEntryKey, getWsContentStatusAttrDef, isAttributeValidForSortingStep, setContextProperties, setRuntimeTableView, 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, getContextProperties, getContextProperty, getContextTypeForTableView, isAttributeValidForSortingStep, isLocalAttributesSupported, setContextProperties, showSetColumnsStep, showSetNameStep, showSortingStep, useBusinessFields

  • Method Details

    • getClassTypes

      public Class[] getClassTypes()
      Get the list of classes that are supported by this table These are supposed to reflect the object types that are shown in tables

      Supported API: true
      Returns:
      List of classes that are supported by table.

      Supported API: true

    • getAttributeOnlyClassTypes

      public Class[] getAttributeOnlyClassTypes()
      Gets the list of classes that are to be used only for supplying attributes These classes are not to be exposed to users in "Choose Item Types" step

      Supported API: true
      Specified by:
      getAttributeOnlyClassTypes in interface ConfigurableTable
      Overrides:
      getAttributeOnlyClassTypes in class com.ptc.core.htmlcomp.tableview.AbstractConfigurableTable
      Returns:
      List of classes that are to be used only for supplying attributes.

      Supported API: true

    • getLabel

      public String getLabel(Locale locale)
      Get the User visible name of the table

      Supported API: true
      Parameters:
      locale - Language for label.
      Returns:
      Returns label of object.

      Supported API: true

    • getOOTBActiveViewName

      public String getOOTBActiveViewName()
      Get the name of the table view that should be the first one If null is returned, the first OOTB table view will be used as default

      Supported API: true
      Returns:
      The name of the table view that should be the first one.

      Supported API: true

    • getOOTBTableViews

      public List<com.ptc.core.htmlcomp.tableview.TableViewDescriptor> getOOTBTableViews(String tableId, Locale locale) throws WTException
      Get the 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

    • getSpecialTableColumnsAttrDefinition

      public List<com.ptc.core.htmlcomp.createtableview.Attribute.AbstractAttribute> getSpecialTableColumnsAttrDefinition(Locale locale)
      Gets the Attribute instances of the columns that are special for this table These attributes are considered as miscellaneous attributes/columns
      Supported API: true
      Parameters:
      locale - Language for attribute.
      Returns:
      Special Table Column Attribute for given locale.

      Supported API: true

    • isColumnLocked

      public boolean isColumnLocked(String columnId)
      tests if the column identified by columnId is a locked column that users cannot remove from their tables

      Supported API: true
      Specified by:
      isColumnLocked in interface ConfigurableTable
      Overrides:
      isColumnLocked in class com.ptc.core.htmlcomp.tableview.AbstractConfigurableTable
      Parameters:
      columnId - Id of Column.
      Returns:
      Is Column Locked.

      Supported API: true

    • getDefaultSortColumn

      public String getDefaultSortColumn()
      Gets the id of the columns that should be used by default for sorting

      Supported API: true
      Returns:
      Id of the columns.

      Supported API: true

    • isAttributeValidForColumnStep

      public boolean isAttributeValidForColumnStep(String key)
      Validates if a given attribute should be available in the "set columns" Step of the create table view wizard

      Supported API: true
      Specified by:
      isAttributeValidForColumnStep in interface ConfigurableTable
      Overrides:
      isAttributeValidForColumnStep in class com.ptc.core.htmlcomp.tableview.AbstractConfigurableTable
      Parameters:
      key - Key of Attribute.
      Returns:
      Is Attribute Valid for column step or not.

      Supported API: true

    • isDefaultSortingAscending

      public boolean isDefaultSortingAscending()
      Gets the Default sort order

      Supported API: true
      Specified by:
      isDefaultSortingAscending in interface ConfigurableTable
      Overrides:
      isDefaultSortingAscending in class com.ptc.core.htmlcomp.tableview.AbstractConfigurableTable
      Returns:
      Is default sorting in ascending order.

      Supported API: true

    • showChooseItemTypesStep

      public boolean showChooseItemTypesStep()
      Should return false if choosing item types is not supported in table (this step allows the user to choose the item types that are to be shown in an instance of the table view - this is filtering by item type)

      Supported API: true
      Specified by:
      showChooseItemTypesStep in interface ConfigurableTable
      Overrides:
      showChooseItemTypesStep in class com.ptc.core.htmlcomp.tableview.AbstractConfigurableTable
      Returns:
      Choosing item types is supported in table or not.

      Supported API: true

    • showFilteringStep

      public boolean showFilteringStep()
      Should return false if filtering is not supported in table

      Supported API: true
      Specified by:
      showFilteringStep in interface ConfigurableTable
      Overrides:
      showFilteringStep in class com.ptc.core.htmlcomp.tableview.AbstractConfigurableTable
      Returns:
      Filtering is supported in table or not.

      Supported API: true