Package adams.flow.core
Interface PyroCall
-
- All Superinterfaces:
CleanUpHandler
,Destroyable
,FlowContextHandler
,OptionHandler
- All Known Subinterfaces:
PyroInputConsumer
,PyroOutputProducer
- All Known Implementing Classes:
AbstractPyroCall
,AbstractPyroSink
,AbstractPyroSource
,AbstractPyroStandalone
,AbstractPyroTransformer
,ExampleGreeting
,Generic
,Generic
,Generic
,Generic
,Null
,Null
,Null
,Null
public interface PyroCall extends OptionHandler, FlowContextHandler, CleanUpHandler
Interface for Pyro4 method calls.- Author:
- FracPete (fracpete at waikato dot ac dot nz)
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
execute()
Performs the call.String
getMethodName()
Returns the name of the method to call.String
getRemoteObjectName()
Returns the name of the remote object to use.String
methodNameTipText()
Returns the tip text for this property.String
remoteObjectNameTipText()
Returns the tip text for this property.void
setMethodName(String value)
Sets the name of the method to call.void
setRemoteObjectName(String value)
Sets the name of the remote object to use.String
setUp()
Configures the call.-
Methods inherited from interface adams.core.CleanUpHandler
cleanUp
-
Methods inherited from interface adams.core.Destroyable
destroy
-
Methods inherited from interface adams.flow.core.FlowContextHandler
getFlowContext, setFlowContext
-
Methods inherited from interface adams.core.option.OptionHandler
cleanUpOptions, defineOptions, getOptionManager, toCommandLine
-
-
-
-
Method Detail
-
setRemoteObjectName
void setRemoteObjectName(String value)
Sets the name of the remote object to use.- Parameters:
value
- the name
-
getRemoteObjectName
String getRemoteObjectName()
Returns the name of the remote object to use.- Returns:
- the name
-
remoteObjectNameTipText
String remoteObjectNameTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setMethodName
void setMethodName(String value)
Sets the name of the method to call.- Parameters:
value
- the name
-
getMethodName
String getMethodName()
Returns the name of the method to call.- Returns:
- the name
-
methodNameTipText
String methodNameTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setUp
String setUp()
Configures the call.- Returns:
- null if successful, otherwise error message
-
execute
String execute()
Performs the call.- Returns:
- null if successful, otherwise error message
-
-