com.whizzosoftware.hobson.api.action.store

Interface ActionStore

public interface ActionStore

An interface for an action-related storage mechanism.

Author:

Dan Noguerol

Method Summary

Modifier and Type	Method and Description
void	close() Closes the store and performs cleanup.
void	deleteActionSet(java.lang.String actionSetId) Deletes an action set from the store.
PropertyContainerSet	getActionSet(HubContext ctx, java.lang.String actionSetId) Returns a particular action set from the store.
java.util.Collection<PropertyContainerSet>	getAllActionSets(HubContext ctx) Returns all action sets in the store.
void	performHousekeeping() Allows the action store to perform whatever implementation-specific housekeeping tasks are needed.
PropertyContainerSet	saveActionSet(HubContext ctx, java.lang.String name, java.util.List<PropertyContainer> actions) Adds an action set to the store.

Method Detail

close

void close()

Closes the store and performs cleanup.

deleteActionSet

void deleteActionSet(java.lang.String actionSetId)

Deletes an action set from the store.

Parameters:

actionSetId - an action set ID

getActionSet

PropertyContainerSet getActionSet(HubContext ctx,
                                  java.lang.String actionSetId)

Returns a particular action set from the store.

Parameters:

ctx - a hub context

actionSetId - an action set ID

Returns:

a PropertyContainerSet instance

getAllActionSets

java.util.Collection<PropertyContainerSet> getAllActionSets(HubContext ctx)

Returns all action sets in the store.

Parameters:

ctx - a hub context

Returns:

a Collection of PropertyContainerSet instances representing the actions

performHousekeeping

void performHousekeeping()

Allows the action store to perform whatever implementation-specific housekeeping tasks are needed.

saveActionSet

PropertyContainerSet saveActionSet(HubContext ctx,
                                   java.lang.String name,
                                   java.util.List<PropertyContainer> actions)

Adds an action set to the store.

Parameters:

ctx - a hub context

name - the name of the action set

actions - the actions that comprise the set

Returns:

a PropertyContainerSet instance representing the new action set