com.whizzosoftware.hobson.api.action

Class ActionClass

java.lang.Object

com.whizzosoftware.hobson.api.property.PropertyContainerClass

com.whizzosoftware.hobson.api.action.ActionClass

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ActionProvider

public class ActionClass
extends PropertyContainerClass

Represents the definition of an action that can be published by plugins/devices and invoked by clients.

Author:

Dan Noguerol

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ActionClass(PropertyContainerClassContext context, java.lang.String name, java.lang.String description, boolean taskAction, long timeoutInterval) Constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Returns the action class description.
java.lang.String	getName() Returns the action class name.
long	getTimeoutInterval() Returns the timeout interval for the action.
boolean	isTaskAction() Indicates whether this action class can be included in tasks.

Methods inherited from class com.whizzosoftware.hobson.api.property.PropertyContainerClass

addSupportedProperty, evaluatePropertyConstraints, getContext, getSupportedProperties, getSupportedProperty, getType, hasSupportedProperties, setContext, setSupportedProperties, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionClass

public ActionClass(PropertyContainerClassContext context,
                   java.lang.String name,
                   java.lang.String description,
                   boolean taskAction,
                   long timeoutInterval)

Constructor.

Parameters:

context - the container class context

name - the name of the action

description - a description of the action

taskAction - should this action be used for tasks?

timeoutInterval - the maximum interval (in ms) the action is allowed to run before it is timed out

Method Detail

getDescription

public java.lang.String getDescription()

Returns the action class description.

Returns:

a String

getName

public java.lang.String getName()

Returns the action class name.

Returns:

a String

getTimeoutInterval

public long getTimeoutInterval()

Returns the timeout interval for the action.

Returns:

a long

isTaskAction

public boolean isTaskAction()

Indicates whether this action class can be included in tasks.

Returns:

a boolean