contentbox.model.search

Interface ISearchAdapter

contentbox.model.search.ISearchAdapter
Class Attributes:
None
All Known Implementing Classes:
DBSearch

ContentBox - A Modular Content Platform Copyright 2012 by Luis Majano and Ortus Solutions, Corp www.ortussolutions.com Apache License, Version 2.0 Copyright Since [2012] [Luis Majano and Ortus Solutions,Corp] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. The official ContentBox Search Interface

Method Summary
ISearchAdapter refresh()
     If chosen to be implemented, it should refresh search indexes and collections.
any renderSearch(string searchTerm, [numeric max], [numeric offset])
     Render the search results according to the adapter and return HTML.
any renderSearchWithResults(SearchResults searchResults)
     Render the search results according the passed in search results object.
SearchResults search(string searchTerm, [numeric max], [numeric offset])
     Search content and return an standardized ContentBox Results object.

Method Detail

refresh

public ISearchAdapter refresh()

If chosen to be implemented, it should refresh search indexes and collections


renderSearch

public any renderSearch(string searchTerm, [numeric max], [numeric offset])

Render the search results according to the adapter and return HTML

Parameters:
searchTerm - The search term to search on
max - The max results to return if paging
offset - The offset to use in the search results if paging

renderSearchWithResults

public any renderSearchWithResults(SearchResults searchResults)

Render the search results according the passed in search results object

Parameters:
searchResults - The search results object

search

public SearchResults search(string searchTerm, [numeric max], [numeric offset])

Search content and return an standardized ContentBox Results object.

Parameters:
searchTerm - The search term to search on
max - The max results to return if paging
offset - The offset to use in the search results if paging