|
ContentBox Core API 1.5.7 | ||||
FRAMES |
WEB-INF.cftags.interfacecontentbox.model.search.ISearchAdapter
public interface ISearchAdapter
******************************************************************************* ContentBox - A Modular Content Platform Copyright 2012 by Luis Majano and Ortus Solutions, Corp www.gocontentbox.org | www.luismajano.com | 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='0'], [numeric offset='0'])
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='0'], [numeric offset='0'])
Search content and return an standardized ContentBox Results object |
Methods inherited from class WEB-INF.cftags.interface |
---|
|
Method Detail |
---|
public ISearchAdapter refresh()
public any renderSearch(string searchTerm, [numeric max='0'], [numeric offset='0'])
searchTerm
- The search term to search onmax
- The max results to return if pagingoffset
- The offset to use in the search results if pagingpublic any renderSearchWithResults(SearchResults searchResults)
searchResults
- The search results objectpublic SearchResults search(string searchTerm, [numeric max='0'], [numeric offset='0'])
searchTerm
- The search term to search onmax
- The max results to return if pagingoffset
- The offset to use in the search results if paging
|
ContentBox Core API 1.5.7 | ||||
FRAMES |