Interface RecordsManagementSearchService

All Known Implementing Classes:
RecordsManagementSearchServiceImpl

public interface RecordsManagementSearchService
Records management search service.
Author:
Roy Wetherall
  • Method Details

    • search

      List<Pair<NodeRef,NodeRef>> search(String siteId, String query, RecordsManagementSearchParameters searchParameters)
      Execute a records management search
      Parameters:
      siteId - the id of the rm site to query
      query - search query string
      searchParameters - search parameters
      Returns:
      List<Pair <NodeRef, NodeRef>> search results as pairs for parent and child nodes
    • getSavedSearches

      List<SavedSearchDetails> getSavedSearches(String siteId)
      Get all the searches saved on the given records management site.
      Parameters:
      siteId - site id
      Returns:
      List<SavedSearchDetails> list of saved search details
    • getSavedSearch

      SavedSearchDetails getSavedSearch(String siteId, String name)
      Get a named saved search for a given records management site.
      Parameters:
      siteId - site id
      name - name of search
      Returns:
      SavedSearchDetails saved search details
    • saveSearch

      SavedSearchDetails saveSearch(String siteId, String name, String description, String search, RecordsManagementSearchParameters searchParameters, boolean isPublic)
      Save records management search.
      Parameters:
      siteId - site id
      name - name
      description - description
      search - search string
      isPublic - indicates whether the saved search is public or not
      Returns:
      SavedSearchDetails details of the saved search
    • saveSearch

      SavedSearchDetails saveSearch(SavedSearchDetails savedSearchDetails)
      Save records management search.
      Parameters:
      savedSearchDetails - details of search to save
      Returns:
      SavedSearchDetails details of the saved search
    • deleteSavedSearch

      void deleteSavedSearch(String siteId, String name)
      Delete saved search
      Parameters:
      siteId - site id
      name - name of saved search
    • deleteSavedSearch

      void deleteSavedSearch(SavedSearchDetails savedSearchDetails)
      Delete saved search
      Parameters:
      savedSearchDetails - saved search details
    • addReports

      void addReports(String siteId)
      Adds the reports as saved searches to a given site.
      Parameters:
      siteId - site id