|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface URLTemplate
Interface of the URL template class that is used to construct parse OpenSearch query templates and expose their parameters
Method Summary | |
---|---|
java.util.List<java.lang.String> |
getOptionalParameters()
Returns a list containing the qualified names of all optional parameters contained in the template |
java.util.List<java.lang.String> |
getRequiredParameters()
Returns a list containing the qualified names of all required parameters contained in the template |
java.lang.String |
getTemplate()
Returns the query template |
boolean |
hasParameter(java.lang.String name)
Determines if the template contains a parameter with a given qualified name |
boolean |
isParameterRequired(java.lang.String name)
Determines if a parameter with a given qualified name is a required parameter |
Method Detail |
---|
java.util.List<java.lang.String> getRequiredParameters()
java.util.List<java.lang.String> getOptionalParameters()
boolean isParameterRequired(java.lang.String name) throws NonExistentParameterException, java.lang.Exception
name
- The qualified name of the parameter
NonExistentParameterException
- If the parameter is not found among the parameters contained in the template
java.lang.Exception
- In case of other errorboolean hasParameter(java.lang.String name)
name
- The qualified name of the parameter
java.lang.String getTemplate()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |