org.exoplatform.services.wcm.search
Interface SiteSearchService

All Known Implementing Classes:

SiteSearchServiceImpl

public interface SiteSearchService

Created by The eXo Platform SAS Author : Hoa Pham hoa.pham@exoplatform.com Oct 7, 2008

Method Summary

void	addExcludeIncludeDataTypePlugin(ExcludeIncludeDataTypePlugin plugin) Adds the exclude include data type plugin.
WCMPaginatedQueryResult	searchSiteContents(org.exoplatform.services.jcr.ext.common.SessionProvider sessionProvider, QueryCriteria queryCriteria, int pageSize, boolean isSearchContent) Search site contents.

Method Detail

addExcludeIncludeDataTypePlugin

void addExcludeIncludeDataTypePlugin(ExcludeIncludeDataTypePlugin plugin)

Adds the exclude include data type plugin.

Parameters:

plugin - the plugin

searchSiteContents

WCMPaginatedQueryResult searchSiteContents(org.exoplatform.services.jcr.ext.common.SessionProvider sessionProvider,
                                           QueryCriteria queryCriteria,
                                           int pageSize,
                                           boolean isSearchContent)
                                           throws java.lang.Exception

Search site contents.
Fill all child nodes of portal which have node type is document, nt:resource or nt:file and check content of them. If node'content have key word, it will be put into list result.
This function have 3 parameters, but the most important is QueryCriteria. With this parameter you only set 5 property:
1. SiteName: name of portal which is searched. If site name is null then search in all portal of system.
2. Keyword: key work to search.
3. SearchDocument and SearchWebContent: two parameter must have save value True or False
4. SearchWebpage: search content of nodes which are added into one or more pages.

Parameters:

queryCriteria - the query criteria

sessionProvider - the session provider

pageSize - the page size

Returns:

the wCM paginated query result

Throws:

java.lang.Exception - the exception