Interface RecordsManagementSearchService
-
- All Known Implementing Classes:
RecordsManagementSearchServiceImpl
public interface RecordsManagementSearchService
Records management search service.- Author:
- Roy Wetherall
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
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 searchSavedSearchDetails
getSavedSearch(String siteId, String name)
Get a named saved search for a given records management site.List<SavedSearchDetails>
getSavedSearches(String siteId)
Get all the searches saved on the given records management site.SavedSearchDetails
saveSearch(String siteId, String name, String description, String search, RecordsManagementSearchParameters searchParameters, boolean isPublic)
Save records management search.SavedSearchDetails
saveSearch(SavedSearchDetails savedSearchDetails)
Save records management search.List<org.alfresco.util.Pair<org.alfresco.service.cmr.repository.NodeRef,org.alfresco.service.cmr.repository.NodeRef>>
search(String siteId, String query, RecordsManagementSearchParameters searchParameters)
Execute a records management search
-
-
-
Method Detail
-
search
List<org.alfresco.util.Pair<org.alfresco.service.cmr.repository.NodeRef,org.alfresco.service.cmr.repository.NodeRef>> search(String siteId, String query, RecordsManagementSearchParameters searchParameters)
Execute a records management search- Parameters:
siteId
- the id of the rm site to queryquery
- search query stringsearchParameters
- 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 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
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 idname
- 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
-
-