Interface PhylogeniesWebserviceClient
- All Known Implementing Classes:
BasicPhylogeniesWebserviceClient
public interface PhylogeniesWebserviceClient
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionA short description of the webservice (~20 characters).Instructions (and examples) on how to use the webservice.A name/description which can appear on a menu.getName()
The name of the webservice.The node data field in which to place node names from simple unannotated formats (such as Newick).This is used to indicate any kind of special processing.To get a type of reference for the webservice (an URL or citation, for example).The expected format of the response.getUrl()
Use QUERY_PLACEHOLDER to indicate position of query variable.boolean
Is the query a number?
-
Field Details
-
QUERY_PLACEHOLDER
- See Also:
-
-
Method Details
-
getDescription
String getDescription()A short description of the webservice (~20 characters).- Returns:
- a short description of the webservice (~20 characters)
-
getInstructions
String getInstructions()Instructions (and examples) on how to use the webservice.- Returns:
- instructions (and examples) on how to use the webservice
-
getMenuName
String getMenuName()A name/description which can appear on a menu.- Returns:
- A name/description which can appear on a menu
-
getName
String getName()The name of the webservice.- Returns:
- the name of the webservice
-
getNodeField
PhylogenyMethods.PhylogenyNodeField getNodeField()The node data field in which to place node names from simple unannotated formats (such as Newick). Null means avoiding any such postprocessing.- Returns:
- the field code
-
getProcessingInstructions
Object getProcessingInstructions()This is used to indicate any kind of special processing.- Returns:
- a reference
-
getReference
String getReference()To get a type of reference for the webservice (an URL or citation, for example).- Returns:
- a reference
-
getReturnFormat
WebservicesManager.WsPhylogenyFormat getReturnFormat()The expected format of the response.- Returns:
- the expected format of the response
-
getUrl
String getUrl()Use QUERY_PLACEHOLDER to indicate position of query variable.- Returns:
- the URL
-
isQueryInteger
boolean isQueryInteger()Is the query a number?- Returns:
-