org.alfresco.module.org_alfresco_module_rm.search

Class RecordsManagementSearchServiceImpl

java.lang.Object

org.alfresco.module.org_alfresco_module_rm.search.RecordsManagementSearchServiceImpl

All Implemented Interfaces:

RecordsManagementSearchService

public class RecordsManagementSearchServiceImpl
extends Object
implements RecordsManagementSearchService

Records management search service implementation

Author:

Roy Wetherall

Constructor Summary

Constructors

Constructor and Description
RecordsManagementSearchServiceImpl()

Method Summary

Modifier and Type	Method and Description
void	addReports(String siteId) Adds the reports as saved searches to a given site.
void	deleteSavedSearch(SavedSearchDetails savedSearchDetails) Delete saved search
void	deleteSavedSearch(String siteId, String name) Delete saved search
SavedSearchDetails	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(SavedSearchDetails savedSearchDetails) Save records management search.
SavedSearchDetails	saveSearch(String siteId, String name, String description, String query, RecordsManagementSearchParameters searchParameters, boolean isPublic) 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 rmSearchParameters) Execute a records management search
void	setFileFolderService(org.alfresco.service.cmr.model.FileFolderService fileFolderService)
void	setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService)
void	setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)
void	setReportsJSON(String reportsJSON)
void	setSearchService(org.alfresco.service.cmr.search.SearchService searchService)
void	setSiteService(org.alfresco.service.cmr.site.SiteService siteService)

Methods inherited from class java.lang.Object

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

Constructor Detail

RecordsManagementSearchServiceImpl

public RecordsManagementSearchServiceImpl()

Method Detail

setFileFolderService

public void setFileFolderService(org.alfresco.service.cmr.model.FileFolderService fileFolderService)

Parameters:

fileFolderService - file folder service

setSearchService

public void setSearchService(org.alfresco.service.cmr.search.SearchService searchService)

Parameters:

searchService - search service

setSiteService

public void setSiteService(org.alfresco.service.cmr.site.SiteService siteService)

Parameters:

siteService - site service

setNamespaceService

public void setNamespaceService(org.alfresco.service.namespace.NamespaceService namespaceService)

Parameters:

namespaceService - namespace service

setNodeService

public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)

Parameters:

nodeService - Node service

setReportsJSON

public void setReportsJSON(String reportsJSON)

Parameters:

reportsJSON -

search

public List<org.alfresco.util.Pair<org.alfresco.service.cmr.repository.NodeRef,org.alfresco.service.cmr.repository.NodeRef>> search(String siteId,
                                                                                                                                    String query,
                                                                                                                                    RecordsManagementSearchParameters rmSearchParameters)

Description copied from interface: RecordsManagementSearchService

Execute a records management search

Specified by:

search in interface RecordsManagementSearchService

Parameters:

siteId - the id of the rm site to query

query - search query string

rmSearchParameters - search parameters

Returns:

List<Pair<NodeRef, NodeRef> search results as pairs for parent and child nodes

See Also:

RecordsManagementSearchService.search(java.lang.String, java.lang.String, org.alfresco.module.org_alfresco_module_rm.search.RecordsManagementSearchParameters)

getSavedSearches

public List<SavedSearchDetails> getSavedSearches(String siteId)

Description copied from interface: RecordsManagementSearchService

Get all the searches saved on the given records management site.

Specified by:

getSavedSearches in interface RecordsManagementSearchService

Parameters:

siteId - site id

Returns:

SavedSearchDetails}> list of saved search details

See Also:

RecordsManagementSearchService.getSavedSearches(java.lang.String)

getSavedSearch

public SavedSearchDetails getSavedSearch(String siteId,
                                         String name)

Description copied from interface: RecordsManagementSearchService

Get a named saved search for a given records management site.

Specified by:

getSavedSearch in interface RecordsManagementSearchService

Parameters:

siteId - site id

name - name of search

Returns:

SavedSearchDetails saved search details

See Also:

RecordsManagementSearchService.getSavedSearch(java.lang.String, java.lang.String)

saveSearch

public SavedSearchDetails saveSearch(String siteId,
                                     String name,
                                     String description,
                                     String query,
                                     RecordsManagementSearchParameters searchParameters,
                                     boolean isPublic)

Description copied from interface: RecordsManagementSearchService

Save records management search.

Specified by:

saveSearch in interface RecordsManagementSearchService

Parameters:

siteId - site id

name - name

description - description

query - search string

isPublic - indicates whether the saved search is public or not

Returns:

SavedSearchDetails details of the saved search

See Also:

org.alfresco.module.org_alfresco_module_rm.search.RecordsManagementSearchService#saveSearch(java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean)

saveSearch

public SavedSearchDetails saveSearch(SavedSearchDetails savedSearchDetails)

Description copied from interface: RecordsManagementSearchService

Save records management search.

Specified by:

saveSearch in interface RecordsManagementSearchService

Parameters:

savedSearchDetails - details of search to save

Returns:

SavedSearchDetails details of the saved search

See Also:

RecordsManagementSearchService.saveSearch(org.alfresco.module.org_alfresco_module_rm.search.SavedSearchDetails)

deleteSavedSearch

public void deleteSavedSearch(String siteId,
                              String name)

Description copied from interface: RecordsManagementSearchService

Delete saved search

Specified by:

deleteSavedSearch in interface RecordsManagementSearchService

Parameters:

siteId - site id

name - name of saved search

See Also:

RecordsManagementSearchService.deleteSavedSearch(java.lang.String, java.lang.String)

deleteSavedSearch

public void deleteSavedSearch(SavedSearchDetails savedSearchDetails)

Description copied from interface: RecordsManagementSearchService

Delete saved search

Specified by:

deleteSavedSearch in interface RecordsManagementSearchService

Parameters:

savedSearchDetails - saved search details

See Also:

RecordsManagementSearchService.deleteSavedSearch(org.alfresco.module.org_alfresco_module_rm.search.SavedSearchDetails)

addReports

public void addReports(String siteId)

Description copied from interface: RecordsManagementSearchService

Adds the reports as saved searches to a given site.

Specified by:

addReports in interface RecordsManagementSearchService

Parameters:

siteId - site id

See Also:

RecordsManagementSearchService.addReports(java.lang.String)