com.whizzosoftware.hobson.api.task

Interface TaskManager

All Superinterfaces:

TaskConditionClassProvider

public interface TaskManager
extends TaskConditionClassProvider

An interface for managing Hobson tasks.

Since:

hobson-hub-api 0.1.6

Author:

Dan Noguerol

Method Summary

Modifier and Type	Method and Description
void	createTask(HubContext ctx, java.lang.String name, java.lang.String description, java.util.List<PropertyContainer> conditions, PropertyContainerSet actionSet) Creates a new task in the system.
void	deleteTask(TaskContext ctx) Deletes a previously added task.
void	executeTask(TaskContext ctx) Manually executes a task.
void	fireTaskTrigger(TaskContext ctx) Indicates that a task trigger condition has been met.
java.util.Collection<TaskConditionClass>	getConditionClasses(HubContext ctx, ConditionClassType type, boolean applyConstraints) Returns all published condition classes.
HobsonTask	getTask(TaskContext ctx) Returns a specific task.
java.util.Collection<HobsonTask>	getTasks(HubContext ctx) Returns all tasks that have been published by all task providers.
void	publishConditionClass(TaskConditionClass conditionClass) Publishes a condition class.
void	updateTask(PluginContext pctx, TaskContext tctx, java.lang.String name, java.lang.String description, boolean enabled, java.util.List<PropertyContainer> conditions, PropertyContainerSet actionSet) Updates an existing task.
void	updateTaskProperties(PluginContext pctx, TaskContext tctx, java.util.Map<java.lang.String,java.lang.Object> properties) Updates a task's properties.

Methods inherited from interface com.whizzosoftware.hobson.api.task.condition.TaskConditionClassProvider

getConditionClass

Method Detail

createTask

void createTask(HubContext ctx,
                java.lang.String name,
                java.lang.String description,
                java.util.List<PropertyContainer> conditions,
                PropertyContainerSet actionSet)

Creates a new task in the system. This is called (e.g. by the REST API) when a request is received to add a new task.

Parameters:

ctx - the hub context

name - the task name

description - the task description

conditions - the task's conditions

actionSet - the task's action set

deleteTask

void deleteTask(TaskContext ctx)

Deletes a previously added task.

Parameters:

ctx - the context of the task

Since:

hobson-hub-api 0.1.6

executeTask

void executeTask(TaskContext ctx)

Manually executes a task.

Parameters:

ctx - the context of the task to execute

fireTaskTrigger

void fireTaskTrigger(TaskContext ctx)

Indicates that a task trigger condition has been met. This is usually called by plugins that detect trigger conditions and will cause the TaskManager to evaluate any additional evaluator conditions the task may have. If they all evaluate to true, or if no evaluator conditions exist, the task's action set will be executed.

Parameters:

ctx - the context of the target hub

getConditionClasses

java.util.Collection<TaskConditionClass> getConditionClasses(HubContext ctx,
                                                             ConditionClassType type,
                                                             boolean applyConstraints)

Returns all published condition classes.

Parameters:

ctx - the context of the hub that published the condition classes

type - filter the results by a type of condition class (or null for all)

applyConstraints - only return condition classes for which the constraints of their typed properties can be met by the currently available system services (i.e. don't show the user things they can't do)

Returns:

a Collection of TaskConditionClass instances

getTask

HobsonTask getTask(TaskContext ctx)

Returns a specific task.

Parameters:

ctx - the context of the task

Returns:

a HobsonTask instance (or null if not found)

Since:

hobson-hub-api 0.1.6

getTasks

java.util.Collection<HobsonTask> getTasks(HubContext ctx)

Returns all tasks that have been published by all task providers.

Parameters:

ctx - the context of the target hub

Returns:

a Collection of HobsonTask objects

Since:

hobson-hub-api 0.1.6

publishConditionClass

void publishConditionClass(TaskConditionClass conditionClass)

Publishes a condition class.

Parameters:

conditionClass - the condition class to publish

updateTask

void updateTask(PluginContext pctx,
                TaskContext tctx,
                java.lang.String name,
                java.lang.String description,
                boolean enabled,
                java.util.List<PropertyContainer> conditions,
                PropertyContainerSet actionSet)

Updates an existing task.

Parameters:

pctx - the plugin updating the task (prevents that plugin from receiving the update event)

tctx - the context of the task to update

name - the new task name

description - the description of the new task

enabled - indicates whether the task should be enabled

conditions - the task's conditions

actionSet - the task's action set

updateTaskProperties

void updateTaskProperties(PluginContext pctx,
                          TaskContext tctx,
                          java.util.Map<java.lang.String,java.lang.Object> properties)

Updates a task's properties.

Parameters:

pctx - the plugin updating the task (prevents that plugin from receiving the update event)

tctx - the task context

properties - the new properties