Package com.webmethods.common.search.results

Interface ISearchResultInfo

All Known Subinterfaces:
ITableOrTreeSearchResultInfo, ITreeSearchResultInfo
public interface ISearchResultInfo
Wrapper around the metadata about search results

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    areRowsSelectable()
    Returns whether the rows in the search results should be selectable.
    String
    getCategoryExpression()
    Return the wm_table compatible expression that specifies the property to use for category headings
    IResultActionInfo[]
    getFunctionBarActions()
    Returns metadata about each of the function bar actions
    IResultColumnInfo[]
    getResultColumnInfos()
    Returns metadata about each of the columns in the search results that should be displayed in the search result portlet
    String
    getRowID()
    Return the wm_table compatible expression that will return the identity value for each row in the search results.

  • Method Details

    • getFunctionBarActions

      IResultActionInfo[] getFunctionBarActions()
      Returns metadata about each of the function bar actions
      Returns:
      array of function bar actions or null of there are no functions

    • areRowsSelectable

      boolean areRowsSelectable()
      Returns whether the rows in the search results should be selectable. When selectable, a checkbox is rendered for each row.
      Returns:
      true if the rows should be selectable, false otherwise

    • getRowID

      String getRowID()
      Return the wm_table compatible expression that will return the identity value for each row in the search results. NOTE: this is only needed if the rows are selectable.
      Returns:
      identity expression

    • getCategoryExpression

      String getCategoryExpression()
      Return the wm_table compatible expression that specifies the property to use for category headings
      Returns:
      category expression

    • getResultColumnInfos

      IResultColumnInfo[] getResultColumnInfos()
      Returns metadata about each of the columns in the search results that should be displayed in the search result portlet
      Returns:
      array of column descriptors