Package org.imixs.workflow.office.views

Class SearchController

java.lang.Object
org.imixs.workflow.faces.data.ViewController
org.imixs.workflow.office.views.SearchController
All Implemented Interfaces:
Serializable
@Named @SessionScoped public class SearchController extends org.imixs.workflow.faces.data.ViewController implements Serializable
The SearchController provides methods for a convenient search experience.

The controller extends the Imixs ViewController and provides custom filter and search queries to request a individual WorkList result. The ItemCollection search filter holds filter criteria for a customized search query.

The bean is session scoped to hold the search filter over a page journey.

The SearchController defines also a set of predefined filter properties:

  • processRef = holds a reference to a core process entity
  • spaceRef = holds a reference to a core space entity
  • phrase = holds the serach phrase
Version:
2.2.0
Author:
rsoika
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected jakarta.enterprise.event.Event<SearchEvent>
    searchEvents
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    SearchController()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDefaultQuery()
     
    org.imixs.workflow.ItemCollection
    getProcess()
     
    String
    getQuery()
    Returns a Lucene search query based on the define searchFilter parameter set
    org.imixs.workflow.ItemCollection
    getSearchFilter()
     
    String
    getSortBy()
    3 = by last update 1 = by created 2 = by created
    org.imixs.workflow.ItemCollection
    getSpace()
     
    String
    getTitle()
     
    void
    init()
    This method set the sort order and sort criteria
    boolean
    isSortReverse()
     
    String
    refreshSearch()
    This method resets the search PageIndex to 0 and updates the bookmarkable search link to the worklist including the current search phrase.
    String
    refreshSearch(jakarta.faces.event.AjaxBehaviorEvent event)
     
    void
    reset()
    Resets the search filter and the current result.
    String
    resetFilter()
    Resets the search filter but not the current search phrase (phrase) and the process reference.
    String
    resetSearch()
    This method reset the search filter but not the phrase.
    void
    setDMSMode(boolean dms)
    Can be set to true to restrict the result to workitems containing attachments.
    void
    setSearchFilter(org.imixs.workflow.ItemCollection searchFilter)
     

    Methods inherited from class org.imixs.workflow.faces.data.ViewController

    getPageIndex, getPageSize, getTotalCount, getTotalPages, getWorkitems, isEndOfList, isLoadStubs, loadData, setEndOfList, setLoadStubs, setPageIndex, setPageSize, setQuery, setSortBy, setSortReverse

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • searchEvents

      @Inject protected jakarta.enterprise.event.Event<SearchEvent> searchEvents

  • Constructor Details

    • SearchController

      public SearchController()

  • Method Details

    • init

      public void init()
      This method set the sort order and sort criteria
      Overrides:
      init in class org.imixs.workflow.faces.data.ViewController

    • getSortBy

      public String getSortBy()
      3 = by last update 1 = by created 2 = by created
      Overrides:
      getSortBy in class org.imixs.workflow.faces.data.ViewController

    • getDefaultQuery

      public String getDefaultQuery()

    • getTitle

      public String getTitle()

    • isSortReverse

      public boolean isSortReverse()
      Overrides:
      isSortReverse in class org.imixs.workflow.faces.data.ViewController

    • getProcess

      public org.imixs.workflow.ItemCollection getProcess()

    • getSpace

      public org.imixs.workflow.ItemCollection getSpace()

    • reset

      public void reset()
      Resets the search filter and the current result.
      Overrides:
      reset in class org.imixs.workflow.faces.data.ViewController
      Parameters:
      event -

    • resetFilter

      public String resetFilter()
      Resets the search filter but not the current search phrase (phrase) and the process reference. The method refreshes also the current result.
      Parameters:
      event -

    • resetSearch

      public String resetSearch()
      This method reset the search filter but not the phrase. The search pageIndex is set to 0 and a new bookmarkable search link to the worklist including the current search phrase is returned.

    • refreshSearch

      public String refreshSearch()
      This method resets the search PageIndex to 0 and updates the bookmarkable search link to the worklist including the current search phrase.

    • refreshSearch

      public String refreshSearch(jakarta.faces.event.AjaxBehaviorEvent event)

    • getSearchFilter

      public org.imixs.workflow.ItemCollection getSearchFilter()

    • setSearchFilter

      public void setSearchFilter(org.imixs.workflow.ItemCollection searchFilter)

    • setDMSMode

      public void setDMSMode(boolean dms)
      Can be set to true to restrict the result to workitems containing attachments.
      Parameters:
      dms -

    • getQuery

      public String getQuery()
      Returns a Lucene search query based on the define searchFilter parameter set

      If a search phrase is given, sortBy and sortReverse are reset. In case of a general search in a specific contest the sortBy and sortReverse are set the settings provided by the setupController

      Overrides:
      getQuery in class org.imixs.workflow.faces.data.ViewController
      Parameters:
      searchFilter - - ItemCollection with filter criteria
      view - - WorkList View type - @see WorklistController
      Returns:
      - a lucene search query