Interface SampleQuery
-
- All Known Implementing Classes:
AllProductsSampleQuery,CountFromLanguageSampleQuery,CountTypeInstancesSampleQuery,OracleCheckEncodingSampleQuery,ShowMySqlTablesSampleQuery,TotalItemCountSampleQuery
public interface SampleQueryInterface which defines sample query which can be used on FlexibleSearch console page. The query can be FlexibleSearch query or direct SQL query, implementing class have to define whether query is FlexibleSearch based or direct. Also database compatibility have to be defined.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.StringgetAdditionalDescription()Gets the additional optional description (to be displayed below main description).java.lang.StringgetQuery()Gets the query string.java.lang.StringgetQueryDescription()Gets the query description.booleanisCompatibleWitCurrentDb()Checks if query is compatible wit current database.booleanisFlexibleSearch()Checks if query is flexible search.
-
-
-
Method Detail
-
getQueryDescription
java.lang.String getQueryDescription()
Gets the query description.- Returns:
- the query description
-
getAdditionalDescription
java.lang.String getAdditionalDescription()
Gets the additional optional description (to be displayed below main description).- Returns:
- the additional description
-
getQuery
java.lang.String getQuery()
Gets the query string.- Returns:
- the query
-
isCompatibleWitCurrentDb
boolean isCompatibleWitCurrentDb()
Checks if query is compatible wit current database.- Returns:
- true, if is compatible wit current database
-
isFlexibleSearch
boolean isFlexibleSearch()
Checks if query is flexible search. False means that query is direct SQL query.- Returns:
- true, if is flexible search
-
-