Package adams.flow.rest

Class AbstractRegisteredFlowRESTPlugin

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.rest.AbstractRESTPlugin

adams.flow.rest.AbstractRegisteredFlowRESTPlugin

All Implemented Interfaces:

adams.core.AdditionalInformationHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, RESTPlugin, Serializable

Direct Known Subclasses:

StopFlow

public abstract class AbstractRegisteredFlowRESTPlugin
extends AbstractRESTPlugin

Ancestor for REST plugins that .

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
AbstractRegisteredFlowRESTPlugin()

Method Summary

Modifier and Type	Method	Description
protected adams.flow.core.Actor	getFlow(int id, boolean loadFromDisk, adams.core.MessageCollection errors)	Retrieves the running flow with the specified ID.

Methods inherited from class adams.flow.rest.AbstractRESTPlugin

getAdditionalInformation

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.GlobalInfoSupporter

globalInfo

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.logging.LoggingSupporter

getLogger, isLoggingEnabled

Constructor Detail

AbstractRegisteredFlowRESTPlugin

public AbstractRegisteredFlowRESTPlugin()

Method Detail

getFlow

protected adams.flow.core.Actor getFlow(int id,
                                        boolean loadFromDisk,
                                        adams.core.MessageCollection errors)

Retrieves the running flow with the specified ID.

Parameters:

id - the ID, use -1 for only running flow

errors - for collecting errors

Returns:

the flow, null if failed to retrieve