AlternativeUrlSupporter (adams-addons-pom 24.12.0-SNAPSHOT API)

All Superinterfaces:

adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.ErrorProvider, adams.core.option.OptionHandler, RESTClient

All Known Implementing Classes:

AbstractRESTClientSink, AbstractRESTClientSource, AbstractRESTClientTransformer, EchoClientSink, EchoClientSource, EchoClientTransformer
```
public interface AlternativeUrlSupporter
extends RESTClient
```
Interface for webservice clients that allow the specification of an alternative URL.

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`alternativeURLTipText()`	Returns the tip text for this property.
`String`	`getAlternativeURL()`	Returns the alternative URL used for the service.
`String`	`getDefaultAlternativeURL()`	Returns the default URL for the service.
`boolean`	`getUseAlternativeURL()`	Returns whether to use the alternative URL used for the service.
`void`	`setAlternativeURL(String value)`	Sets the alternative URL to use.
`void`	`setUseAlternativeURL(boolean value)`	Sets whether to use the alternative URL.
`String`	`useAlternativeURLTipText()`	Returns the tip text for this property.

Methods inherited from interface adams.core.CleanUpHandler
cleanUp

Methods inherited from interface adams.core.Destroyable
destroy

Methods inherited from interface adams.core.ErrorProvider
getLastError, hasLastError

Methods inherited from interface adams.core.option.OptionHandler
cleanUpOptions, defineOptions, getOptionManager, toCommandLine

Methods inherited from interface adams.flow.rest.RESTClient
getConnectionTimeout, getOwner, getReceiveTimeout, query, setConnectionTimeout, setOwner, setReceiveTimeout

- Method Detail
  - setUseAlternativeURL
```
void setUseAlternativeURL(boolean value)
```
    Sets whether to use the alternative URL.
    
    Parameters:
    
    value - whether to use the alternative URL
  - getUseAlternativeURL
```
boolean getUseAlternativeURL()
```
    Returns whether to use the alternative URL used for the service.
    
    Returns:
    
    true if to use alternative URL
  - useAlternativeURLTipText
```
String useAlternativeURLTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - getDefaultAlternativeURL
```
String getDefaultAlternativeURL()
```
    Returns the default URL for the service.
    
    Returns:
    
    the URL
  - setAlternativeURL
```
void setAlternativeURL(String value)
```
    Sets the alternative URL to use.
    
    Parameters:
    
    value - the URL to use
  - getAlternativeURL
```
String getAlternativeURL()
```
    Returns the alternative URL used for the service.
    
    Returns:
    
    the URL
  - alternativeURLTipText
```
String alternativeURLTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.