Package com.ptc.core.htmlcomp.tableview

Interface ConfigurableTable

All Known Implementing Classes:
com.ptc.core.htmlcomp.tableview.AbstractConfigurableTable, AbstractImpactTableViews, AbstractListChangeItemTableViews, AddComponentResultsTableView, AffectedDataTableViews, AffectedEndItemsTableViews, AssociatedChangeIssuesTableViews, AssociatedChangeRequestsTableViews, AssociatedChangeTableViews, ChangeSummaryTableViews, ChangeTableViews, ChangeTaskAffectedItemsTableViews, ChangeTaskResultingItemsTableViews, ChangeWorkitemTableViews, CollectAffectedObjectsJSTableViews, CollectResultingObjectsJSTableViews, ConfigurableDescribeLinkTableViews, ConfigurableLinkTableViews, ConfigurableMastersLinkTableViews, ConfigurableReferenceLinkTableViews, ConfigurableRevisionLinkTableViews, CreateOrEditMultiObjectViews, FlexibleChangeItemSearchTableViews, ImpactedObjectsTableViews, ImpactorObjectsTableViews, JCAConfigurableTable, ListChangeNoticesTableViews, ListChangeRequestsTableViews, ListProblemReportsTableViews, ListVariancesTableViews, ProjectProblemReportsTableViews, ProjectVariancesTableViews, RelatedWorkSetTableViews, com.ptc.netmarkets.search.views.SearchAbstractResultTableView, VarianceAffectedDataTableViews, WorkflowTaskChangeSummaryTableViews, WorkflowTaskResultingItemsTableViews, WorkSetComponentsTableViews
public interface ConfigurableTable
Interface that provides methods for getting all the data that is required by the table customization code for a table that is configurable If different behavior is desired for any given table than is delivered out of the box, it is acceptable to extend any of the implementers of this interface or their subclasses even though the may not be marked as Extendable.

Supported API: true

Extendable: true

  • Method Details

    • getLabel

      String getLabel(Locale locale)
      Get the User visible name of the table.
      Parameters:
      locale - Language for label.
      Returns:
      Returns label of object.

      Supported API: true

    • getSpecialTableColumnsAttrDefinition

      List getSpecialTableColumnsAttrDefinition(Locale locale)
      Gets the Attribute instances of the columns that are special for this table These attributes are considered as miscellaneous attributes/columns.
      Parameters:
      locale - Language for attribute.
      Returns:
      Special Table Column Attribute for given locale.

      Supported API: true

    • getClassTypes

      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.
      Returns:
      List of classes that are supported by table.

      Supported API: true

    • getAttributeOnlyClassTypes

      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.
      Returns:
      List of classes that are to be used only for supplying attributes.

      Supported API: true

    • getOOTBTableViews

      List getOOTBTableViews(String tableId, Locale locale) throws WTException
      Get the Out Of The Box table views.
      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

    • getOOTBActiveViewName

      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.
      Returns:
      The name of the table view that should be the first one.

      Supported API: true

    • isColumnLocked

      boolean isColumnLocked(String columnId)
      Tests if the column identified by columnId is a locked column that users cannot remove from their tables.
      Parameters:
      columnId - Id of Column.
      Returns:
      Is Column Locked.

      Supported API: true

    • canAttributeBeUsedInFilter

      boolean canAttributeBeUsedInFilter(String attributeId)
      Tests if a given attribute, identified by its id, should be used when creating filters for a table.
      Parameters:
      attributeId - Id of attribute.
      Returns:
      Can Attributed used as in filter or not.

      Supported API: true

    • isAttributeValidForColumnStep

      boolean isAttributeValidForColumnStep(String key)
      Validates if a given attribute should be available in the "set columns" Step of the create table view wizard.
      Parameters:
      key - Key of Attribute.
      Returns:
      Is Attribute Valid for column step or not.

      Supported API: true

    • isAttributeValidForSortingStep

      boolean isAttributeValidForSortingStep(String key)
      Validates if a given attribute should be available in the "Set sorting" Step of the create table view wizard.
      Parameters:
      key - Key of Attribute.
      Returns:
      Is Attribute Valid for sorting step step or not.

      Supported API: true

    • showFilteringStep

      boolean showFilteringStep()
      Should return false if filtering is not supported in table.
      Returns:
      Filtering is supported in table or not.

      Supported API: true

    • showSortingStep

      boolean showSortingStep()
      Should return false if setting sorting is not supported in table.
      Returns:
      Setting sorting is supported in table or not.

      Supported API: true

    • showSetColumnsStep

      boolean showSetColumnsStep()
      Should return false if setting columns is not supported in table.
      Returns:
      Setting columns is supported in table or not.

      Supported API: true

    • showSetNameStep

      boolean showSetNameStep()
      Should return false if the "Set Name step is not to be shown IMPORTANT: This usually should not be customized and should only be used for tables that have one table view and do not allow to create multiple table views.
      Returns:
      Show Set Name step displayed or not.

      Supported API: true

    • showChooseItemTypesStep

      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).
      Returns:
      Choosing item types is supported in table or not.

      Supported API: true

    • getDefaultSortColumn

      String getDefaultSortColumn()
      Gets the id of the columns that should be used by default for sorting.
      Returns:
      Id of the columns.

      Supported API: true

    • isDefaultSortingAscending

      boolean isDefaultSortingAscending()
      Gets the Default sort order.
      Returns:
      Is default sorting in ascending order.

      Supported API: true

    • getContextProperties

      Properties getContextProperties()
      Get access to the properties that provide context to the table view editor .
      Returns:
      Properties that provide context to the table view editor.

      Supported API: true

    • setContextProperties

      void setContextProperties(Properties props)
      Set the properties that provide context to the table view editor .
      Parameters:
      props - Properties that provide context.

      Supported API: true

    • getContextProperty

      String getContextProperty(String propertyKey)
      Get a particular context property.
      Parameters:
      propertyKey - Key of property.
      Returns:
      Particular context property.

      Supported API: true

    • useBusinessFields

      boolean useBusinessFields()
      Use the BusinessField infrastructure to get attributes instead of AvailableAttributes.
      Returns:
      Use of business field.

      Supported API: true

    • isLocalAttributesSupported

      default boolean isLocalAttributesSupported()
      Method to indicate whether the Table is supporting local attributes. By default it is false i.e. not supporting local attributes. Application code implementation is free to override this method and return true if application is capable to handle local attributes.
      Returns:
      Whether the Table is supporting local attributes.

      Supported API: true

    • getContextTypeForTableView

      default ConfigurableTable.ContextTypeForCustomize getContextTypeForTableView()
      Get context type for table View.
      Returns:
      Context type for customize.

      Supported API: true