com.whizzosoftware.hobson.api.action

Interface Action

All Known Implementing Classes:

CompositeAction, SingleAction

public interface Action

Represents an action created by an ActionProvider. Actions run within the context of Job objects managed by the ActionManager.

Author:

Dan Noguerol

Method Summary

Modifier and Type	Method and Description
boolean	isAssociatedWithPlugin(PluginContext ctx) Indicates whether this action is associated with a particular plugin.
Future	sendMessage(ActionLifecycleContext ctx, java.lang.String msgName, java.lang.Object prop) Sends a message to the action.
Future	start(ActionLifecycleContext ctx) Starts the action.
Future	stop(ActionLifecycleContext ctx) Stops the action.

Method Detail

isAssociatedWithPlugin

boolean isAssociatedWithPlugin(PluginContext ctx)

Indicates whether this action is associated with a particular plugin.

Parameters:

ctx - the plugin context

Returns:

a boolean

sendMessage

Future sendMessage(ActionLifecycleContext ctx,
                   java.lang.String msgName,
                   java.lang.Object prop)

Sends a message to the action.

Parameters:

ctx - the lifecycle context

msgName - the name of the message

prop - a property object

Returns:

a Future

start

Future start(ActionLifecycleContext ctx)

Starts the action.

Parameters:

ctx - the lifecycle context

Returns:

a Future

stop

Future stop(ActionLifecycleContext ctx)

Stops the action.

Parameters:

ctx - the lifecycle context

Returns:

a Future