SiteSearchIndexBuilder (sakai-search-api 22.2 API)

All Superinterfaces:: SearchIndexBuilder

public interface SiteSearchIndexBuilder
extends SearchIndexBuilder

Field Summary
- Fields inherited from interface org.sakaiproject.search.api.SearchIndexBuilder
  DEFAULT_INDEX_BUILDER_NAME, DEFAULT_INDEX_NAME

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`List<SearchBuilderItem>`	`getSiteMasterSearchItems()`	get a list of Master Search Items that control the search operation for the Site (current site)
`boolean`	`isExcludeUserSites()`
`boolean`	`isOnlyIndexSearchToolSites()`
`void`	`rebuildIndex(String currentSiteId)`	Rebuild the index for the supplied siteId
`void`	`refreshIndex(String currentSiteId)`	Refresh the index for the supplied siteId

Methods inherited from interface org.sakaiproject.search.api.SearchIndexBuilder
addResource, destroy, getAllSearchItems, getContentProducers, getGlobalMasterSearchItems, getName, getPendingDocuments, isBuildQueueEmpty, newEntityContentProducer, newEntityContentProducer, rebuildIndex, refreshIndex, registerEntityContentProducer

- Method Detail
  - rebuildIndex
```
void rebuildIndex(String currentSiteId)
```
    Rebuild the index for the supplied siteId
    
    Parameters:
    
    currentSiteId -
  - refreshIndex
```
void refreshIndex(String currentSiteId)
```
    Refresh the index for the supplied siteId
    
    Parameters:
    
    currentSiteId -
  - getSiteMasterSearchItems
```
List<SearchBuilderItem> getSiteMasterSearchItems()
```
    get a list of Master Search Items that control the search operation for the Site (current site)
    
    Returns:
  - isOnlyIndexSearchToolSites
```
boolean isOnlyIndexSearchToolSites()
```
  - isExcludeUserSites
```
boolean isExcludeUserSites()
```