| com.flexive.shared.interfaces.SearchEngine
All known Subclasses: com.flexive.ejb.beans.search.SearchEngineBean,
SearchEngine | public interface SearchEngine (Code) | | |
Method Summary | |
public long | getLastContentChange(boolean live) Returns the last time that any content that affects queries was changed. | QueryRootNode | load(ResultLocation location, String name) Load the query of the given name, for the current user. | QueryRootNode | loadDefault(ResultLocation location) Load the default query for the given type/location. | Collection<String> | loadNames(ResultLocation location) Returns the names of the stored queries for the calling user/location. | void | remove(ResultLocation location, String name) Remove the query of the given name and type from the database. | void | save(QueryRootNode query) Store the given query for the current user. | void | saveDefault(QueryRootNode query) Sets the user-defined default query for the query's type and location. | void | saveSystemDefault(QueryRootNode query) Sets the system-wide default query for the query's type and location. | public FxResultSet | search(String query, int startIndex, Integer fetchRows, FxSQLSearchParams params) Executes a query. | public FxResultSet | search(String query, int startIndex, Integer fetchRows, FxSQLSearchParams params, ResultLocation location, ResultViewType viewType) Executes a query. |
getLastContentChange | public long getLastContentChange(boolean live)(Code) | | Returns the last time that any content that affects queries was changed.
Parameters: live - if true only the last changes of live contents are checked the last time that any content that affects queries was changed |
loadDefault | QueryRootNode loadDefault(ResultLocation location) throws FxApplicationException(Code) | | Load the default query for the given type/location. If none is set, an empty query is returned.
Parameters: location - the query location, usually matched to the location of its result the default query for the given type/location throws: FxApplicationException - if the default query could not be loaded |
search | public FxResultSet search(String query, int startIndex, Integer fetchRows, FxSQLSearchParams params) throws FxApplicationException(Code) | | Executes a query.
Parameters: query - the query to execute Parameters: startIndex - return data starting at the given row, 0 based Parameters: fetchRows - the maximum rows to fetch, or null to fetch all found entries Parameters: params - all additional search options the result set throws: FxApplicationException - if the search failed |
search | public FxResultSet search(String query, int startIndex, Integer fetchRows, FxSQLSearchParams params, ResultLocation location, ResultViewType viewType) throws FxApplicationException(Code) | | Executes a query.
Parameters: query - the query to execute Parameters: startIndex - return data starting at the given row, 0 based Parameters: fetchRows - the maximum rows to fetch, or null to fetch all found entries Parameters: params - all additional search options Parameters: location - the result location Parameters: viewType - the result view type the result set throws: FxApplicationException - if the search failed |
|
|