|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface QueryElement
Interface of the Query Element class that is used to process Query elements contained in a DescriptionDocument
| Method Summary | |
|---|---|
boolean |
describesExampleQuery()
Determines whethe the query element describes an example query |
java.lang.String |
getCount()
Returns the value of the count OpenSearch parameter contained in the query element |
java.lang.String |
getInputEncoding()
Returns the value of the inputEncoding OpenSearch parameter contained in the query element |
java.lang.String |
getLanguage()
Returns the value of the language OpenSearch parameter contained in the query element |
java.lang.String |
getOutputEncoding()
Returns the value of the outputEncoding OpenSearch parameter contained in the query element |
java.util.Map<java.lang.String,java.lang.String> |
getQueryParameters()
Returns all parameters contained in the query element along with their corresponding values |
java.lang.String |
getRole()
Returns the role of the search request described in the query element |
java.lang.String |
getSearchTerms()
Returns the value of the searchTerms OpenSearch parameter contained in the query element |
java.lang.String |
getStartIndex()
Returns the value of the startIndex OpenSearch parameter contained in the query element |
java.lang.String |
getStartPage()
Returns the value of the startPage OpenSearch parameter contained in the query element |
java.lang.String |
getTitle()
Returns a description describing the search request described in the query element |
java.lang.String |
getTotalResults()
Returns the expected number of results that will be returned if the search request contained in the query element were made |
boolean |
isRoleSupported()
Determines whether the query element supports the query role provided |
void |
parse()
Processes a query element |
| Method Detail |
|---|
void parse()
throws java.lang.Exception
java.lang.Exception - If the query element is not valid according to the OpenSearch specification or in case of other error
java.lang.String getRole()
throws java.lang.Exception
java.lang.Exception - If the query element is not initialized or in case of other error
java.lang.String getTitle()
throws java.lang.Exception
java.lang.Exception - If the query element is not initialized or in case of other error
java.lang.String getTotalResults()
throws java.lang.Exception
java.lang.Exception - If the query element is not initialized or in case of other error
java.lang.String getSearchTerms()
throws java.lang.Exception
java.lang.Exception - If the query element is not initialized or in case of other error
java.lang.String getCount()
throws java.lang.Exception
java.lang.Exception - If the query element is not initialized or in case of other error
java.lang.String getStartIndex()
throws java.lang.Exception
java.lang.Exception - If the query element is not initialized or in case of other error
java.lang.String getStartPage()
throws java.lang.Exception
java.lang.Exception - If the query element is not initialized or in case of other error
java.lang.String getLanguage()
throws java.lang.Exception
java.lang.Exception - If the query element is not initialized or in case of other error
java.lang.String getInputEncoding()
throws java.lang.Exception
java.lang.Exception - If the query element is not initialized or in case of other error
java.lang.String getOutputEncoding()
throws java.lang.Exception
java.lang.Exception - If the query element is not initialized or in case of other error
boolean describesExampleQuery()
throws java.lang.Exception
java.lang.Exception - If the query element is not initialized or in case of other error
java.util.Map<java.lang.String,java.lang.String> getQueryParameters()
throws java.lang.Exception
java.lang.Exception - In case of error
boolean isRoleSupported()
throws java.lang.Exception
java.lang.Exception - If the query element is not initialized or in case of other error
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||