Package com.webmethods.caf.faces.search.options

Interface ISearchResultsOptionsManager

All Known Implementing Classes:
SimpleWebAppSearchResultsOptionsManager
public interface ISearchResultsOptionsManager
Implementations provide management for search results options

  • Field Details

    • KEY_INITIAL_SORT_BY

      static final String KEY_INITIAL_SORT_BY
      This search result option controls which column is used to sort the search results The value must be the id of a sortable column.
      See Also:

    • KEY_INITIAL_SORT_ASCENDING

      static final String KEY_INITIAL_SORT_ASCENDING
      This search result option controls whether the search result data is sorted in ascending or descending order. The value must be either true or false.
      See Also:

    • KEY_COLUMN_DISPLAY

      static final String KEY_COLUMN_DISPLAY
      This search result option controls which table columns are visible. The value must be an array of column ids that should be displayed in the given order.
      See Also:

    • KEY_COLUMN_WIDTH

      static final String KEY_COLUMN_WIDTH
      This search result option controls the widths of the displayed columns. The value must be a positive number.
      See Also:

    • KEY_INITIAL_PAGE_SIZE

      static final String KEY_INITIAL_PAGE_SIZE
      This search result option controls how many rows are displayed on each page of search results. The value must be an array of column ids that should be displayed in the given order.
      See Also:

    • KEY_INITIAL_EXPORT_PAGE_SIZE

      static final String KEY_INITIAL_EXPORT_PAGE_SIZE
      See Also:

  • Method Details

    • getDisplayColumnsPreference

      String[] getDisplayColumnsPreference()
      Return the display column preference. Usually via a portlet property that is configured from the portlet edit mode.
      Returns:
      array of column ids that should be displayed in the given order

    • setDisplayColumnsPreference

      void setDisplayColumnsPreference(String[] columnDisplay)
      Sets the display column preference. Usually via a portlet property that is configured from the portlet edit mode. param array of column ids that should be displayed in the given order

    • getColumnWidthsPreference

      String getColumnWidthsPreference()
      Return the column widths preference. Usually via a portlet property that is configured from the portlet edit mode.
      Returns:
      csv-style map of column ids to column widths (ie "colOne=60%,colTwo=40%,colThree=20px")

    • setColumnWidthsPreference

      void setColumnWidthsPreference(String columnWidths)
      Sets the column widths preference. Usually via a portlet property that is configured from the portlet edit mode. param csv-style map of column ids to column widths (ie "colOne=60%,colTwo=40%,colThree=20px")

    • getInitialSortByPreference

      String getInitialSortByPreference()
      Return the initialSortBy preference. Usually via a portlet property that is configured from the portlet edit mode.
      Returns:
      id of the column to sort by initially

    • setInitialSortByPreference

      void setInitialSortByPreference(String sortBy)
      Sets initial sortBy preference
      Parameters:
      sortBy - the column id to sort by

    • getInitialSortAscendingPreference

      boolean getInitialSortAscendingPreference()
      Return the initialSortBy preference. Usually via a portlet property that is configured from the portlet edit mode.
      Returns:
      id of the column to sort by initially

    • setInitialSortAscendingPreference

      void setInitialSortAscendingPreference(boolean ascending)
      Sets initialSortBy preference.
      Parameters:
      ascending - true for ascending sort, false for descening sort

    • getInitialPageSize

      int getInitialPageSize()
      Returns page size for search results display
      Returns:
      the number of rows to display on each page of results

    • setInitialPageSize

      void setInitialPageSize(int pageSize)
      Sets initialPageSize preference
      Parameters:
      pageSize - the number of rows to display on each page of results

    • getInitialExportPageSize

      int getInitialExportPageSize()
      Returns page size for export table
      Returns:
      the number of rows to export

    • setInitialExportPageSize

      void setInitialExportPageSize(int pageSize)
      Sets initialExportPageSize preference
      Parameters:
      pageSize - the number of rows to export