com.whizzosoftware.hobson.api.task

Class HobsonTask

java.lang.Object

com.whizzosoftware.hobson.api.task.HobsonTask

public class HobsonTask
extends java.lang.Object

A generic interface for entities that trigger Hobson actions.

Author:

Dan Noguerol

Constructor Summary

Constructors

Constructor and Description
HobsonTask()
HobsonTask(TaskContext context, java.lang.String name, java.lang.String description, boolean enabled, java.util.Map<java.lang.String,java.lang.Object> properties, java.util.List<PropertyContainer> conditions, PropertyContainerSet actionSet)

Method Summary

Modifier and Type	Method and Description
PropertyContainerSet	getActionSet() Returns the action set ID associated with this task.
java.util.List<PropertyContainer>	getConditions() Returns the condition set for this task.
TaskContext	getContext() Returns the context of the task.
java.util.Collection<PropertyContainerClassContext>	getDependencies(ActionClassProvider actionClassProvider) Returns the PropertyContainerClassContexts that this task is dependent on.
java.lang.String	getDescription() Returns a human-readable description of the task.
java.lang.String	getName() Returns the task name.
java.util.Map<java.lang.String,java.lang.Object>	getProperties() A list of arbitrary properties associated with the task.
boolean	hasConditions() Returns whether this task has any conditions.
boolean	hasProperties() Indicates whether this task has any properties associated with it.
boolean	isEnabled()
void	setActionSet(PropertyContainerSet actionSet) Sets the action set for this task.
void	setConditions(java.util.List<PropertyContainer> conditions) Sets the condition set for this task.
void	setContext(TaskContext context) Sets the context of the task.
void	setDescription(java.lang.String description) Sets a human-readable description of the task.
void	setEnabled(boolean enabled)
void	setName(java.lang.String name) Sets the task name.
void	setProperties(java.util.Map<java.lang.String,java.lang.Object> properties) Sets the task properties.
void	setProperty(java.lang.String name, java.lang.Object value) Sets a task property.

Methods inherited from class java.lang.Object

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

Constructor Detail

HobsonTask

public HobsonTask()

HobsonTask

public HobsonTask(TaskContext context,
                  java.lang.String name,
                  java.lang.String description,
                  boolean enabled,
                  java.util.Map<java.lang.String,java.lang.Object> properties,
                  java.util.List<PropertyContainer> conditions,
                  PropertyContainerSet actionSet)

Method Detail

getContext

public TaskContext getContext()

Returns the context of the task.

Returns:

a TaskContext instance

setContext

public void setContext(TaskContext context)

Sets the context of the task.

Parameters:

context - a TaskContext intsance

getName

public java.lang.String getName()

Returns the task name.

Returns:

a String

setName

public void setName(java.lang.String name)

Sets the task name.

Parameters:

name - the name

getDescription

public java.lang.String getDescription()

Returns a human-readable description of the task.

Returns:

a String

setDescription

public void setDescription(java.lang.String description)

Sets a human-readable description of the task.

Parameters:

description - the description

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

hasProperties

public boolean hasProperties()

Indicates whether this task has any properties associated with it.

Returns:

a boolean

getProperties

public java.util.Map<java.lang.String,java.lang.Object> getProperties()

A list of arbitrary properties associated with the task. For example, a scheduler might use one of these properties to indicate a task is scheduled for execution.

Returns:

a Properties object

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)

Sets a task property.

Parameters:

name - the property name

value - the property value

setProperties

public void setProperties(java.util.Map<java.lang.String,java.lang.Object> properties)

Sets the task properties.

Parameters:

properties - the full set of task properties

getConditions

public java.util.List<PropertyContainer> getConditions()

Returns the condition set for this task.

Returns:

a condition set (or null if one hasn't been set)

hasConditions

public boolean hasConditions()

Returns whether this task has any conditions.

Returns:

a boolean

setConditions

public void setConditions(java.util.List<PropertyContainer> conditions)

Sets the condition set for this task.

Parameters:

conditions - the task conditions

getActionSet

public PropertyContainerSet getActionSet()

Returns the action set ID associated with this task.

Returns:

the action set ID (or null if none is set)

setActionSet

public void setActionSet(PropertyContainerSet actionSet)

Sets the action set for this task.

Parameters:

actionSet - the new action set

getDependencies

public java.util.Collection<PropertyContainerClassContext> getDependencies(ActionClassProvider actionClassProvider)

Returns the PropertyContainerClassContexts that this task is dependent on.

Parameters:

actionClassProvider - a provider to resolve action classes

Returns:

a Collection of PropertyContainerClassContext instances