org.cristalise.kernel.lifecycle.routingHelpers

Interface DataHelper

All Known Implementing Classes:

ActivityDataHelper, PropertyDataHelper, ViewpointDataHelper

public interface DataHelper

Method Summary

Modifier and Type	Method and Description
String	get(ItemPath itemPath, String actContext, String dataPath, Object locker) Data helpers are a mechanism that allows easy referencing of different types of data within an Item, in order to use that data for process control or generating new data.

Method Detail

get

String get(ItemPath itemPath,
           String actContext,
           String dataPath,
           Object locker)
    throws InvalidDataException,
           PersistencyException,
           ObjectNotFoundException

Data helpers are a mechanism that allows easy referencing of different types of data within an Item, in order to use that data for process control or generating new data. They are referenced using a URI-like syntax, usually in workflow vertex properties. Check wiki for more information.

Parameters:

itemPath - the current item to be used

actContext - the current Activity path in which the DataHelper is used

dataPath - its content is implementation specific

locker - the transaction locker object used for ClusterStorage methods

Returns:

The resolved value

Throws:

InvalidDataException - data inconsistency

PersistencyException - persistency issue

ObjectNotFoundException - object was not found