Interface RecordsManagementSearchService
- All Known Implementing Classes:
RecordsManagementSearchServiceImpl
public interface RecordsManagementSearchService
Records management search service.
- Author:
- Roy Wetherall
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addReports
(String siteId) Adds the reports as saved searches to a given site.void
deleteSavedSearch
(String siteId, String name) Delete saved searchvoid
deleteSavedSearch
(SavedSearchDetails savedSearchDetails) Delete saved searchgetSavedSearch
(String siteId, String name) Get a named saved search for a given records management site.getSavedSearches
(String siteId) Get all the searches saved on the given records management site.saveSearch
(String siteId, String name, String description, String search, RecordsManagementSearchParameters searchParameters, boolean isPublic) Save records management search.saveSearch
(SavedSearchDetails savedSearchDetails) Save records management search.search
(String siteId, String query, RecordsManagementSearchParameters searchParameters) Execute a records management search
-
Method Details
-
search
List<Pair<NodeRef,NodeRef>> search(String siteId, String query, RecordsManagementSearchParameters searchParameters) Execute a records management search -
getSavedSearches
Get all the searches saved on the given records management site.- Parameters:
siteId
- site id- Returns:
List
<SavedSearchDetails
> list of saved search details
-
getSavedSearch
Get a named saved search for a given records management site.- Parameters:
siteId
- site idname
- 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 idname
- namedescription
- descriptionsearch
- search stringisPublic
- indicates whether the saved search is public or not- Returns:
SavedSearchDetails
details of the saved search
-
saveSearch
Save records management search.- Parameters:
savedSearchDetails
- details of search to save- Returns:
SavedSearchDetails
details of the saved search
-
deleteSavedSearch
Delete saved search- Parameters:
siteId
- site idname
- name of saved search
-
deleteSavedSearch
Delete saved search- Parameters:
savedSearchDetails
- saved search details
-
addReports
Adds the reports as saved searches to a given site.- Parameters:
siteId
- site id
-